d9985f9d4d
* Update system notice to plugin * Add plugin model alembic support * update plugin conf * add plugin route injection * update plugin route inject * fix and optimize plugin router inject
FBA Project - Backend
Docker
Important
Due to Docker context limitations, you can't build an image in this directory
-
Make sure you're at the root of the project
-
Run the following Docker command to build container:
docker build -f backend/backend.dockerfile -t fba_backend_independent . -
Start container
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
- Git
- uv
- Fork this repository to your GitHub account
-
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 uv venv uv pip install -r requirements.txt -
Checkout a new branch and make your changes
# Checkout a new branch and make your changes git checkout -b your-new-feature-branch -
Run linting
# Run automated code formatting and linting pre-commit run --all-files -
Commit and push your changes
Commit your changes, push your branch to GitHub, and create a pull request.
Scripts
Warning
The following script may not apply to the Windows platform
It is recommended to execute under the backend directory, and chmod authorization may be required
-
pre_start.sh: Perform automatic database migration and create database tables -
celery-start.sh: For celery docker script, implementation is not recommended -
scripts/format.sh: Perform ruff format check -
scripts/lint.sh: Perform pre-commit formatting -
scripts/export.sh: Execute uv export dependency package