Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dotpep/social-media-api
Social Media API using FastAPI, Postgres and deployed to Cloud with testings, ci/cd and etc.
https://github.com/dotpep/social-media-api
Last synced: 3 days ago
JSON representation
Social Media API using FastAPI, Postgres and deployed to Cloud with testings, ci/cd and etc.
- Host: GitHub
- URL: https://github.com/dotpep/social-media-api
- Owner: dotpep
- Created: 2024-02-18T09:56:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-04T20:00:42.000Z (9 months ago)
- Last Synced: 2024-03-05T20:15:28.804Z (9 months ago)
- Language: Python
- Size: 390 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Social Media App API using FastAPI
Demonstration of project in website here [https://dotpep.xyz] link and API docs in below:
- Swagger/OpenAPI docs: [https://dotpep.xyz/docs]
- Redoc docs: [https://dotpep.xyz/redoc]
- API testing tool/client [Collection of requests/endpoints and Automatiom to testing API](/docs/README.md)
---
- Docker image: [https://hub.docker.com/repository/docker/dotpep/social-media-fastapi]
## Demonstration
### FastAPI endpoints/routes
### Pydantic Schemas
## Tech stack
- FastAPI
- Pydantic
- PostgreSQL
- SQLAlchemy
- Alembic
## Features
Endpoints:
- You can create and login/auth with new user
- You can create, update, delete and retrieve posts
- You can vote on posts that you liked
---
- API and docs with FastAPI
- Data Validation with Pydantic
- Authentication with OAuth2 JWT Token
- PostgreSQL as Database
- SQLAlchemy as ORM
- Alembic as Migration tool and for SQLAlchemy
- Contenirezed with Docker
- Deployed to cloud hosting on DigitalOcean DROPLETS
- Server setup on VPS Ubuntu VM
- Nginx and Gunicorn on Server
- Production featured
- Tesing API with PyTest
- Additional API documentation with Insomnia testing/client http tool and .json file of collections
## TO DO
- [x] CRUD Operations and Routes/Endpoints
- [x] Authentication with OAuth2 JWT Token
- [x] Validation with Pydantic
- [x] Alembic Migrations
- [x] Documentation with Auto generated FastAPI docs and with API testing/client tool collection .json file using Insomnia
- [x] Testing with PyTest, UnitTest
- [x] Deployment on Cloud VPS or Hosting
- [x] Conteinerize with Docker & Docker compose
- [x] Configure Nginx and Uvicorn ASGI, Gunicorn workers
- [ ] GitHub action, CI/CD Pipeline
- [ ] Refactor, Apply Clean Architecture, SOLID principles, Best practices and Common patterns for Backend/API
- [x] Restructure project
- [ ] Continue project, add new features, ideas like logging etc.
## How to run locally
Pre-requisites (Requirements)
Locally:
1. Python version > 3.8
2. Poetry(Optional)
3. PostgreSQL version > 13
- Or just Docker
---
1. Clone this repo by: `git clone "https://github.com/dotpep/social-media-api.git"`
---
With Docker (Easy way to run)
1. Install Docker
2. Run dev-server: `docker-compose -f .\docker-compose-dev.yml up` by specify `-d` flag it runs in background and to see logs `docker-compose -f .\docker-compose-dev.yml logs -f`
3. Stop: `docker-compose -f .\docker-compose-dev.yml down`
- Also for convenience you can delete `docker-compose-prod.yml` and rename `docker-compose-dev.yml` to `docker-compose.yml` and use short command `docker-compose up` without `-f .\docker-compose-dev.yml`
- If you want use `.env` as environment variables in `docker-compose-dev.yml` uncomment `#env_file: # - ./.env` this line and comment `environment` section
---
Without Docker (Localy)
1. Setup environment variables on `.env.example` file to create Postgres Database (If the database is not created automatically, you will need to create it manually).
2. Make Migrations of database models using Alembic
3. Run Uvicorn server for FastAPI and Install Dependencies requirements.txt to Virtual Environment venv
---
- You need provide Postgres database secret data like db_name, user_name, password etc into `.env` file.
- In below instruction section:
### Setting up Environment variables files (In Development)
> In Production, you must set this environment variables in Your machine/server as Permanent System-wide Environment Variables, in Development you can just use `.env` file
- Change this file in base dir of project with your required config variables: `.env.example`
- After setting your env variables data rename this `.env.example` file to `.env.`
- Provide values to empty variable values (create postgres database)
---
Postgres Database env variables
```.env
DATABASE_HOSTNAME=localhost
DATABASE_PORT=5432
DATABASE_PASSWORD=yourpassword
DATABASE_NAME=yourdbname
DATABASE_USERNAME=postgres
```
---
JWT Token env variables
- You can use just my setting for JWT token or use own
- to generate SECRET_KEY you can use this command `openssl rand -hex 32`
```.env
SECRET_KEY=9b68c9f53ff13f75b890b62af1d9435d65827796d21ceb16c5fe431f054dcde3
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=60
```
---
- If somthings doesn't work try to delete `# Comment` in `.env` file I think this may help
---
- Create venv and Install dependencies
- In below instruction section:
### Create Venv and Install dependencies package from requirements.txt or use Poetry
- Using poetry (run step by step)
1. Install poetry: `pip install poetry`, Check poetry installation: `poetry --version`, if needed add poetry to env variable
2. (Optional) Setup poetry to create venv inside project: `poetry config virtualenvs.in-project true`
3. Generate venv: `poetry shell`
4. Install all depe`poetry install`
5. (Additonal Information) to exit activated venv you can write: `exit`
---
- Using python venv/pip (run step by step)
1. Create venv: `python -m venv venv`
2. Activate venv: `.\venv\Scripts\activate` (in VS code specify this venv in Python Intepreter command) also you activate specific `\Scripts\activate` like with `.ps`, `.bash`, `.bat`
3. Install all needed package/dependency to venv: `pip install -r requirements.txt`
4. (Additonal Information) to exit activated venv you can write: `deactivate`
---
- And migrate this database tables/entity using Alembic
- In below instruction section:
### Alembic Postgres database, SQLAlchemy models Migrations
- migrate to last rivision: `alembic upgrade head`
### Running uvicorn server
- Run fastapi uvicorn server: `uvicorn app.main:app`
- Run it in automatic reload mode when you change code with reload flag: `uvicorn app.main:app --reload`
- Also you can specify port by: `--port 5000` by default: is `8000`
---
- How to stop background uvicorn server in windows (powershell) if any error or is still running in background:
- CTRL + C to quit.
- `netstat -ano | findstr :8080`
- `Stop-Process -id ` or `kill `