Loading repository data…
Aeternalis-Ingenium / repository
A backend project template with FastAPI, PostgreSQL with asynchronous SQLAlchemy 2.0, Alembic for asynchronous database migration, and Docker.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
This is a template repository aimed to kick-start your project with a setup from a real-world application! This template utilizes the following tech stack:
When the Docker is started, these are the URL addresses:
http://localhost:8001/docshttp//localhost:8081The backend API without Docker can be found in http://localhost:8000/docs.
Well, the easy answer is Asynchronousity and Speed!
The above-listed technologies are just the main ones. There are other technologies utilized in this project template to ensure that your application is robust and provides the best possible development environment for your team! These technologies are:
Selected from shared topics, language and repository description—not editorial ratings.
yahrdev /
This project is a backend application built with FastAPI and MySQL. It uses FastAPI Users (https://fastapi-users.github.io/fastapi-users/latest/) for user management and employs asynchronous programming for improved performance.
31/100 healthPyenvimport for clarity. Also for Python.My choice for a project development workflow is usually the Trunk-Based Development because of the straightforward approach in the collaboration workflow, hence the name trunk for the main branch repository instead of master or main.
For the backend application:
backend/pyproject.toml.backend/src/config/settings/base.py.backend/src/config/events.py.Account object table model in backend/src/models/db/account.py.Account object schema model in backend/src/models/schemas/account.py.backend/src/repository/database.py.backend/src/repository/table.pybackend/src/repository/database.py.backend/src/repository/events.py.Account object in backend/src/repository/crud/account.py.backend/src/repository/base.py.backend/src/repository/migration/**.backend/alembic.ini.backend/src/api/**.Account signup and signin in backend/src/api/routes/authentication.py.Account get all, get 1, update, and delete in backend/src/api/routes/account.py.backend/src/api/endpoints.backend/src/securities/**.backend/src/utilities/**.backend/src/main.py.For testing, I have prepared the following simple code to kick-start your test-driven development:
backend/tests/conftest.py.tests/unit_tests/test_src.py.For the DevOps:
build job to test the compilation of the source code for the backend application in .github/workflows/ci-backend.yaml.code-style with black, isort, flake8, and mypy in .github/workflows/ci-backend.yaml.PyTest and an automated test reporting with Codecov in in .github/workflows/ci-backend.yaml..github/CODEOWNERS (Please change the username to your own).YAML file for an automated semantic commit message in .github/workflows/ci-backend.yaml.Codecov in codecov.yamlYAML file in .pre-commit-config.YAML.For containerization:
Docker configuration that utilizes the latest Python image in backend/Dockerfile.backend/entrypoint.sh.Postgres image for our database server, Adminer for our database editor, and backend_app for our backend application's container in docker-compose.yaml.For the team development environment:
Black, Isort, and MyPy to ensure the conventional commit message before pushing an updated code into the remote repository in .pre-commit-config.YAML..env.example. You need to copy these variables and set the values respectively to your need and save them in a new .env in the root directory.This backend application is setup with Docker. Nevertheless, you can see the full local setup without Docker in backend/README.md.
Before setting up the backend app, please create a new directory called coverage for the testing report purpose:
cd backend && mkdir coverage
Backend app setup:
# Creating VENV
pyenv virtualenv 3.11.0 any_venv_name
pyenv local any_venv_name
# Install dependencies
pip3 install -r requirements.txt
# Test run your backend server
uvicorn src.main:backend_app --reload
Testing with PyTest:
Make sure that you are in the backend/ directory.
# For testing without Docker
pytest
# For testing within Docker
docker exec backend_app pytest
Pre-Commit setup:
# Make sure you are in the ROOT project directory
pre-commit install
pre-commit autoupdate
Backend app credentials setup:
If you are not used to VIM or Linux CLI, then ignore the echo command and do it manually. All the secret variables for this template are located in .env.example.
If you want to have another name for the secret variables, don't forget to change them also in:
backend/src/config/base.pydocker-compose.yaml# Make sure you are in the ROOT project directory
touch .env
echo "SECRET_VARIABLE=SECRET_VARIABLE_VALUE" >> .env
CODEOWNERS setup:
Go to .github/ and open CODEOWNERS file. This file is to assign the code to a specific team member so you can distribute the weights of the project clearly.
Docker setup:
# Make sure you are in the ROOT project directory
chmod +x backend/entrypoint.sh
docker-compose build
docker-compose up
# Every time you write a new code, update your container with:
docker-compose up -d --build
(IMPORTANT) Database setup:
# (Docker) Generate revision for the database auto-migrations
docker exec backend_app alembic revision --autogenerate -m "YOUR MIGRATION TITLE"
docker exec backend_app alembic upgrade head # to register the database classes
# (Local) Generate revision for the database auto-migrations
alembic revision --autogenerate -m "YOUR MIGRATION TITLE"
alembic upgrade head # to register the database classes
Go to https://about.codecov.io/, and sign up with your github to get the CODECOV_TOKEN
Go to your GitHub and register all the secret v