README.md

April 27, 2026 ยท View on GitHub

Mentioned in Awesome FastAPI

Stay tuned. Refactor in progress, see legacy-2025 branch for architecture docs

TODO:

  • Write tests
  • Explain code and patterns in new README
  • Make template project

Prerequisites

uv sync
source .venv/bin/activate
pre-commit install --hook-type pre-commit --hook-type pre-push

Start in Docker

make upd

Start locally

make upd-local
alembic upgrade head
uvicorn app.main.run:make_app --host 0.0.0.0 --port 8000 --reload
# or `src/app/main/run.py` in IDE

Full API access:

  • create user via sign up
  • set its role to super_admin manually in DB
  • log in as super admin

Stop

make down

Test (light paths)

make check

Test (all paths)

make test-docker

Generate a migration

make migration msg=<msg>

See Makefile for more commands

Thanks for your patience and support

Acknowledgements