zendus/fastapi-blog-api

A fully functional blog API built using FastAPI framework with features like vote post (like, unlike), comment on a post, upload image along with post (Cloudinary), etc.

FastAPI-blog-api

A blog API built using FastAPI framework with features like vote post (like, unlike), comment on a post, upload image along with post (Cloudinary), etc.

How to Install

1. Clone the project in your local computer.

2. Create a virtualenv file.

3. Terminal/CLI command: pip install --upgrade pip to update your pip version.

4. Install all dependencies with pip install -r requirements.txt

5. Run uvicorn app.main:app to start the server.

Main Dependencies

FastAPI for api server
Uvicorn - lightweight ASGI server
Pydantic to create schemas (comes with FastAPI by default)
Swagger UI for API documentation (embedded in FastAPI by default)
Redocs - alternative API documentation (embedded in FastAPI by default)
SQLAlchemy - database orm for interacting with SQL database
Bcrypt - for password hashing
ItsDangerous - for generating jwt tokens used for user authentication
Fastapi-Mail - for sending verification mail to new user
Cloudinary - for post image upload
Psycopg2 - for postgreSQL database integration

Documentation

Click here to view swagger documentation