FastAPI Template

Built-In Features:

• UV
• JWT Auth
• Admin (SQLAdmin)
• ORM (SQLModel / SQLAlquemy)
• Migration (Alembic)
• Tests (Pytest)
• Coverage (Coverage)
• camelCase API
• Celery
• Docker
• PostgreSQL
• Redis
• CI/CD (Github Actions)
• AWS Lamdba (Mangum)

Quick Start

1. Install Docker on your machine.
2. Start Docker.
3. Add the environment variables in the .env file.
4. Open the terminal in the root of the project.
5. Build the image:

docker compose build

6. Run the migrations:

docker compose run web alembic upgrade head

7. Run the containers

docker compose up --watch

8. When you want to stop the containers, press Ctrl+C or:

docker compose down

API Documentation

1. Run the containers

docker compose up --watch

2. Access:

• Swagger: http://localhost:8000/api/v1/docs
• Redoc: http://localhost:8000/api/v1/redoc

Run Tests

docker compose run web pytest

Run Tests with Coverage

1. Run tests with Pytest.

docker compose run web coverage run -m pytest

2. To check the test coverage, it is possible to use Terminal Report or HTML.

Terminal Report

3. Run:

docker compose run web coverage report

HTML

3. Run:

docker compose run web coverage html

4. Initialize the /htmlcov directory generated by the test coverage using the Live-Server extension in VSCode.
5. Go to http://localhost:5500/htmlcov/
6. Check the test coverage via HTML:

Delete Database

docker compose down -v

Create migration

docker compose run web alembic revision --autogenerate -m “first_commit”

Migrate

docker compose run web alembic upgrade head

Downgrade

docker compose run web alembic downgrade base

List Migrations History

docker compose run web alembic history

Run Commands in Container terminal

docker compose run web COMMAND

Seeds

docker compose run web python app/seeds.py

Deploy

1. Create your account in AWS

2. Install AWS CLI

3. Login in AWS CLI

4. Change variables in ./scripts/setup.sh:

REGION="us-east-1"
AWS_ACCOUNT_ID="111111111111"
PROJECT_NAME="fastapi-template"

5. Run setup.sh script:

sh ./scripts/setup.sh

6. Change AWS Lambda function URL permissions in AWS Console