BazaroZero / aphorism

:headphones: REST API of social network

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

logo_small

Yandex.Lyceum Flask project

Aphorism is the REST API of a new social networking concept or we can call it a podcast platform. Posts can only consist of short captions and a voice message. At the moment the backend is ready. The web version will most likely be developed later.

Description 📋

  • Each user will have his own profile with gravatar, where you can post, see statistics, change status
  • The feed will consist of posts by people the user is subscribed to. You can "Like" a post as usual
  • Using the search will allow to find new authors

Using 🎧

git clone https://github.com/xDiaym/aphorism.git

Move to project's directory

docker-compose up

Check swagger documentation on http://localhost:8000/api/v1/docs

Testing ✔️

To run the tests, simply do the following in a Linux environment (in Windows it can be WSL)

tests/test.sh

Approximate web version design 🖥️

You can see the progress in the feature/frontend branch

  • Index page index_page

  • Sign up page sign_up

  • Feed page feed

About

:headphones: REST API of social network

License:GNU General Public License v3.0


Languages

Language:Python 93.1%Language:Shell 3.3%Language:Dockerfile 2.8%Language:Mako 0.9%