FastAPI - Starter Setup

---

Read-to-Use Framework + ORM + OAuth + Docker 🎉

---

Packages Included

Essential packages for FastAPI-Boilerplate as following,

	Package Version	Purpose
Python	3.12.x	Backend
FastAPI	0.115.6	Framework - ASGI
PostgreSQL	16.3	Database
SQLAlchemy	2.0.36	ORM for Database
APScheduler	3.11.0	Cron and Background Tasks
logzero	1.7.0	Logger
Passlib	1.7.4	Password Hashing
Jose	1.0.0	Auth JWT Token

Installation

Base App

$ git clone https://github.com/shankarThiyagaraajan/fastapi_starter.git <your-project-name>

$ cd <your-project-name>
$ python3 -m venv env    # Optional setup for Virtual Environment
$ pip install -r requirements.txt

Database via Docker

$ docker compose up -d

For DB Migrations:

$ alembic revision --autogenerate -m "Your Quick Migration Note"
$ alembic upgrade head

To Start App

$ fastapi dev main.py

Debug: Default setup is ready to support VsCode debugger

To Test App

$ pytest

Happy Coding...!