This API has 4 routes

1) /posts Route

This route is reponsible for creating a post, deleting a post, updating a post and retrieving post(s).

2) /users Route

This route is for creating users and searching user by id.

3) /auth Route

This route is for logging into the system.

4) /vote Route

This route is for the likes or vote system. This route contains code to upvote or remove vote. There is not logic for down vote.

How to run locally

First clone this repo by using following command

git clone https://github.com/yazmintorres/learn-fastapi.git

then

cd fastapi-project

then install all dependencies

pip install -r requirements.txt

then run the following command

uvicorn app.main:app --reload

then you can use following link to use the API

http://127.0.0.1:8000/docs 

This API requires a database in PostgreSQL

Create a database in postgres then create a file name .env in the root folder and write the following things in the file

DB_HOSTNAME = localhost
DB_PORT = 5432
DB_PASSWORD = passward_that_you_set
DB_NAME = name_of_database
DB_USERNAME = User_name
SECRET_KEY = 09d25e094faa2556c818166b7a99f6f0f4c3b88e8d3e7 
ALGORITHM = HS256
ACCESS_TOKEN_EXPIRE_MINUTES = 60

Then, run the following command from the root folder to create the necessary tables

alembic upgrade head

Note: SECRET_KEY in this exmple is just a pseudo key. You need to get a key for youself and you can get the SECRET_KEY from FastAPI Documentation - Obtain a Secret Key