mirror of
https://github.com/fastapi-practices/fastapi_best_architecture.git
synced 2026-03-13 09:31:31 +08:00
5e438c685d
* define the basic architecture * Update script and deployment file locations * Update the route registration * Fix CI download dependencies * Updated ruff to 0.3.3 * Update app subdirectory naming * Update the model import * fix pre-commit pdm lock * Update the service directory naming * Add CRUD method documents * Fix the issue of circular import * Update the README document * Update the SQL statement for create tables * Update docker scripts and documentation * Fix docker scripts * Update the backend README.md * Add the security folder and move the redis client * Update the configuration item * Fix environment configuration reads * Update the default configuration * Updated README description * Updated the user registration API * Fix test cases * Update the celery configuration * Update and fix celery configuration * Updated the celery structure * Update celery tasks and api * Add celery flower * Update the import style * Update contributors
FBA Project - Backend
Docker
Important
Due to Docker context limitations, you cannot successfully build a image using a Dockerfile in the current directory
-
Make sure you're at the root of the project
-
Run the following Docker command to build a image:
docker build -f backend/backend.dockerfile -t fba_backend_independent . -
Start decker image
docker run -d fba_backend_independent -p 8000:8000 --name fba_app
Contributing
-
Prerequisites
You'll need the following prerequisites:
- Any Python version between Python >= 3.10
- virtualenv or other virtual environment tool
- git
- PDM
-
Installation and setup
# Clone your fork and cd into the repo directory git clone https://github.com/<your username>/fastapi_best_architecture.git cd fastapi_best_architecture/backend # Install requirements.txt pdm install -
Check out a new branch and make your changes
# Checkout a new branch and make your changes git checkout -b your-new-feature-branch # Make your changes... -
Run linting
# Run automated code formatting and linting pdm lint -
Commit and push your changes
Commit your changes, push your branch to GitHub, and create a pull request.