README.md

Api-Python Template

A template repo for a rich dev-container for developing a FastAPI backend that deploys to a Docker container.

Features

1. A python base devcontainer for a consistent development environment.
   1. Based on Microsoft's devcontainer spec.
   2. Uses the host's timezone ($TZ) and Github CLI token ($GITHUB_TOKEN).
   3. If $GITHUB_TOKEN is set, it will clone the user's dotfiles repository and run its install.sh after creating the container. See jifalops/dotfiles for an example.
   4. Local shell history is persisted when rebuilding the container.
2. Integrated terminals when opened with VS Code:
   1. Run unit tests and start the local server.
3. Hexagonal architecture (ports and adapters) with feature-based modules.
   1. Static typing and dependency injection.
4. All config comes from environment variables.
5. Runs locally using docker-compose.yml.
6. Works with Postgres, Neo4j (todo), and MongoDB (todo) databases.
7. Supports JWT, fastapi-users, and Firebase auth out of the box (todo).
8. Github Actions for CI/CD (todo).