https://github.com/zbhavyai/fastapi-template
A ready-to-use template for building backend applications using Python and FastAPI
https://github.com/zbhavyai/fastapi-template
ci-cd docker docker-compose fastapi pytest ruff template-project
Last synced: 5 months ago
JSON representation
A ready-to-use template for building backend applications using Python and FastAPI
- Host: GitHub
- URL: https://github.com/zbhavyai/fastapi-template
- Owner: zbhavyai
- License: mit
- Created: 2025-09-22T22:24:37.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-28T00:30:04.000Z (9 months ago)
- Last Synced: 2025-09-28T02:35:28.580Z (9 months ago)
- Topics: ci-cd, docker, docker-compose, fastapi, pytest, ruff, template-project
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastAPI Template
A **starter template** for building backend applications with [FastAPI](https://fastapi.tiangolo.com/), the high-performance Python web framework.
## :sparkles: Tech Stack and Features
- :zap: [FastAPI](http://fastapi.tiangolo.com/), the high-performance Python web framework
- :jigsaw: [Pydantic](https://docs.pydantic.dev/) for data validation and settings management
- :gear: [SQLAlchemy](https://www.sqlalchemy.org/) and [asyncpg](https://github.com/MagicStack/asyncpg) for non-blocking database access
- :elephant: [PostgreSQL](https://www.postgresql.org/) as the production-ready relational database
- :luggage: [Alembic](https://alembic.sqlalchemy.org/) for version-controlled database migrations
- :open_file_folder: Defined project structure with ready-to-use [`pyproject.toml`](pyproject.toml) and [pydantic settings](app/core/settings.py)
- :pen: [VS Code](https://code.visualstudio.com/) settings included
- :art: [Ruff](https://docs.astral.sh/ruff/) for consistent code formatting and linting
- :page_facing_up: [.editorconfig](https://editorconfig.org/) for consistent coding styles across editors
- :broom: A `pre-commit` hook for style enforcement
- :test_tube: [pytest](https://docs.pytest.org/en/stable/) tests to keep code honest
- :whale: Containerization with Dockerfile and docker compose
- :otter: Automatic [Podman](https://podman.io/)/[Docker](https://www.docker.com/) detection for local dev
- :hammer_and_wrench: [Makefile](https://www.gnu.org/software/make/) targets for format, build, run, and container tasks
- :vertical_traffic_light: [GitHub Actions](https://github.com/features/actions) for CI/CD
- :label: Artifact versioning based on Git SHA or tag, both in CI/CD and local builds
- :robot: [Dependabot](https://github.com/dependabot) for automated dependency updates
## :rocket: Getting started
- Before you start development on this project, run the `init` target. This will install a pre-commit hook and install dependencies.
```shell
make init
```
- Run the application in dev mode that enables live coding.
```shell
make dev
```
- To format the code while developing, you may use for IDE and turn on the auto-formatting on save. You may also use the format target.
```shell
make format
```
## :package: Packaging and running
1. Build the application
```shell
make build
# OR
make container-build
```
1. Run the application
```shell
make run
# OR
make container-run
```
## :page_facing_up: License
The FastAPI Template is licensed under the terms of the [MIT license](LICENSE).