Skip to content
/ starter-api Public template

A no-brainer starter for a dockerised FastAPI app

License

Notifications You must be signed in to change notification settings

jonwhittlestone/starter-api

Repository files navigation

starter-api

Continuous Integration

Usage

make up-build

Run the command above and then visit: https://127.0.0.1:8004

See snippets-resources.md for handy snippets and resources.

Debug FastAPI using VSCode

  1. Run this:

    make up-build
  2. In vscode add a breakpoint

  3. Run the debugger (F5)

  4. Visit: https://127.0.0.1:8004

  5. The vscode debugger will pause execution at your breakpoint.

Features

- [x] Dockerised w/debug
- [x] Postgres service / SQLModel + SQLAlchemy / Alembic migrations
- [x] Poetry, Dynaconf
- [x] Containerised tests
- [x] Github Action to run tests
- [ ] FastAPI repositories, schemas / logging / cleanup and mocked tests
- [ ] Production deployment
- [ ] Pre-commit / manage.py / migrations
- [ ] Tag this repo and release

About

A no-brainer starter for a dockerised FastAPI app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published