https://github.com/Donnype/fastapi-template
A FastAPI and SQLAlchemy project template with Docker and GitHub Actions.
https://github.com/Donnype/fastapi-template
fastapi fastapi-boilerplate fastapi-sqlalchemy fastapi-template makefile python
Last synced: 18 days ago
JSON representation
A FastAPI and SQLAlchemy project template with Docker and GitHub Actions.
- Host: GitHub
- URL: https://github.com/Donnype/fastapi-template
- Owner: Donnype
- License: mit
- Created: 2022-10-17T21:24:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T07:45:59.000Z (6 months ago)
- Last Synced: 2024-12-04T03:34:57.618Z (5 months ago)
- Topics: fastapi, fastapi-boilerplate, fastapi-sqlalchemy, fastapi-template, makefile, python
- Language: Python
- Homepage: https://bitestreams.com/blog/fastapi_template/
- Size: 162 KB
- Stars: 124
- Watchers: 2
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - Donnype/fastapi-template - A FastAPI and SQLAlchemy project template with Docker and GitHub Actions. (Python)
README
# Fastapi Project Template
A FastAPI project template using Make, Docker Compose and Github Actions,
that includes **SQLAlchemy**, **Alembic** and an integration test setup.[](https://github.com/bitestreams/fastapi-template/actions/workflows/code-integration.yml)
## Installation
The only requirements to develop are **Docker** and **Make**.
Docker makes it easy to get started and enables easier switching between projects, operating systems and machines.To start up the project locally you first clone the project, and then run the following command in the cloned directory:
```sh
$ git clone https://github.com/Donnype/fastapi-template.git
$ cd fastapi-template
$ make up
```
Then to update the schema using alembic, in another shell:
```sh
$ make migrate
```
**That's it**. The app is set up and should be running at [localhost:5000/docs](localhost:5000/docs).
Code changes are automatically detected using a mounted docker volume.### Makefile
---
The Makefile is the 'entrypoint' for the tools in this structure,
such that you can easily run different commands without remembering the exact arguments.
Run `make help` to get an overview of the available commands:
```sh
$ make help
up:
Run the application
done: check test
Prepare for a commit
test: utest itest
Run unit and integration tests
utest: cleantest
Run unit tests
itest: cleantest
Run integration tests
check: cleantest
Check the code base
cleantest:
Clean up test containers
migrations:
Generate a migration using alembic
migrate:
Run migrations upgrade using alembic
downgrade:
Run migrations downgrade using alembic
help:
Display this help message
```Make allows you to collect common scripts and commands for the project.
Other projects using different programming languages and frameworks get the same development interface by using Make.---
### Installation without Docker
To install a local copy of the python environment (to get code-completion for example),
you must have **Poetry** installed.
Create a poetry environment by running `poetry install` at the root of the project.
To start up the server in the poetry environment and talk to a test sqlite database in `./test.db`, run
```bash
$ export DB_STRING=sqlite:///test.db/
$ poetry run alembic upgrade head && poetry run uvicorn api.main:app --port 5000 --reload
```
Again, the app should be all set up and running at [localhost:5000/docs](localhost:5000/docs).### Tests
---
The tests are containerized and the Docker setup can be found in the `.ci/` folder.
They are written using Pytest.
You can run the tests using:
```bash
$ make test
```
This runs the integration & unit tests.
If you want to run them separately, use `make itest` to run the integration tests and `make utest` to run the unit tests.## Further reading
To read about the benefits of using this template,
check out [my blog post](https://bitestreams.com/blog/fastapi_template/).