Fastapi Postgres template

A simple backend template with a user system, jwt token management and email sending.

Technology stack & features

• FastAPI
  • SQLModel
  • Pydantic
  • PostreSQL
• Docker & Docker Compose
• Secure password hashing & JWT authentication
• Password recovery with email
• Tests

System requirements

• Docker
• Make
• uv

Development

Setup

1. Create .env by copying .env.template

   cp .env.template .env

2. Run the project

   make dev

The app will be launched on port 8000 and it's possible to view the API docs on http://localhost:8000/docs

Useful commands

There's a makefile that has multiple useful commands defined within it

• make dev - runs the backend container
• make build - builds the backend container
• make prod - runs a prod version of the container that's smaller
• make shell - runs and attached to the backend container
• make check - formats and checks the code
• make test - runs tests and shows the total code coverage
• make test-email - sends a test email to an email designated in .env
• make migrations title="migration title" - generates a new migration

Command to connect to any running container:

docker exec -it <container_id> bash

Command to connect to a postgresql container:

docker exec -it <container_id> psql -U postgres

Commiting code

Pre-commit hooks are set up to check the code on commits - configuration file. To install pre-commit hooks run pre-commit install. More info here.

To run the checks before committing, run:

pre-commit run

Migrations

Migrations are managed and generated automatically using Alembic. To automatically create a migration run:

make migrations title="migration title"

Adding dependencies

after adding a dependency with uv it's necessary to rebuild the backend docker container to update the containers dependencies

make build

Production

To build a small docker image for prod run:

make prod