PipeKnight / fastapi-alembic-sqlmodel-async

This is a project template which uses FastAPI, Alembic and async SQLModel as ORM. It shows a complete async CRUD using authentication.

Async configuration for FastAPI and SQLModel

This is a project template which uses FastAPI, Alembic and async SQLModel as ORM. It shows a complete async CRUD template using authentication.

Set environment variables

Create an .env file on root folder and copy the content from .env.example. Feel free to change it according to your own configuration.

Run project using Docker compose

docker-compose up --build

Run Alembic migrations

docker-compose exec fastapi_server alembic revision --autogenerate
docker-compose exec fastapi_server alembic upgrade head

Setup database with initial data

This creates a sample user on databasse with username: [e-mail] and pass: admin

docker-compose exec fastapi_server python app/initial_data.py

You can connect to the Database using PGAdmin4 and use the credentials from .env file. Database port on local machine has been configured to 5454 on docker-compose.yml file

ERD Database model

As this project uses traefik, you can access to the documentation with the following path http://fastapi.localhost/docs

Preview

Traefik Dashboard

You can access to Traefik Dashboard using the following link http://traefik.localhost/. You should use username: test and pass: test. If you want to change the password, you can find more information of how to do it here

Static files

All files on static folder will be server by nginx container as static files. You can check it with this link http://localhost/static/1.png

Inspiration and References

• full-stack-fastapi-postgresql.
• fastapi-sqlmodel-alembic.
• sqlmodel-tutorial.

TODO List:

• Add Custom Response model
• Create sample one to many relationship
• Create sample many to many relationship
• Add JWT authentication
• Add Pagination
• Add User birthday field with timezone
• Add reverse proxy (traefik) with docker compose
• Add static server with nginx
• Add jsonb field on table sample
• Add Role - Permissions setup and logic
• Add one to one relationship sample
• Add Celery sample for tasks

PR are welcome ❤️

License

• This project is licensed under the terms of the MIT license