https://github.com/jifalops/api-python

Devcontainer template for a FastAPI backend that builds to a Docker image.
https://github.com/jifalops/api-python

Last synced: about 1 month ago
JSON representation

Devcontainer template for a FastAPI backend that builds to a Docker image.

• Host: GitHub
• URL: https://github.com/jifalops/api-python
• Owner: jifalops
• License: mit
• Created: 2024-11-19T21:58:55.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-05T13:39:43.000Z (about 1 month ago)
• Last Synced: 2024-12-05T14:34:15.860Z (about 1 month ago)
• Language: Python
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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][1] spec.

    1. Uses the host's timezone (`$TZ`) and Github CLI token (`$GITHUB_TOKEN`).

    1. 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][2] for an example.

    1. Local shell history is persisted when rebuilding the container.

1. Integrated terminals when opened with VS Code:

    1. Run unit tests and start the local server.

1. Hexagonal architecture (ports and adapters) with feature-based modules.

    1. Static typing and dependency injection.

1. All config comes from environment variables.

1. Runs locally using docker-compose.yml.

1. Works with Postgres, Neo4j (todo), and MongoDB (todo) databases.

1. Supports JWT, fastapi-users, and Firebase auth out of the box (todo).

1. Github Actions for CI/CD (todo).

[1]: https://github.com/devcontainers/images/tree/main/src/typescript-node

[2]: https://github.com/jifalops/dotfiles

[3]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers

[4]: https://github.com/jifalops/dotfiles/blob/bf9627445abf5ffe25515e8a6d2fe1d1c681e606/.sh_common#L87