mirror of https://github.com/fastapi-practices/fastapi_best_architecture.git synced 2026-03-13 09:31:31 +08:00

Files

Wu Clan 2b56168ad0 Refactor foreign keys and relationships to pure logic (#901 )

* Refactor foreign keys and relationships to pure logic

* Revert of some changes

* More revert

* Update the user paginate

* Update user create and update

* Update dept select and delete

* Rename the join query functions

* Update select_join_serialize doc and README

* Fix typo in README

* Update the user delete

* Update the user social

* Update the dict plugin crud

* Update the dict plugin version

* Bump dependencies and pre-commits

* Update the code generator plugin crud

* Update the menu crud

* Update the role crud

* Update the data scope and rule crud

* Restore get_paginated to get_select

* Update the code generator plugin version

* Add the py version in pre-commit

* Remove the plugin include parameter config

* Add more cache cleaning TODO

* Rename get_with_relation to get_join

* Add the user cache clear

* Fix known compatibility issues

* Update the version number to 1.11.0

* Fix lint

* Optimize select_join_serialize logic

* Delete cache cleanup comments

* Update the oauth2 plugin version

* Fix user-role table cleanup when user update

2025-11-12 13:06:26 +08:00

alembic

Update the ruff rules and format the code (#846 )

2025-10-10 19:02:49 +08:00

app

Refactor foreign keys and relationships to pure logic (#901 )

2025-11-12 13:06:26 +08:00

common

Refactor foreign keys and relationships to pure logic (#901 )

2025-11-12 13:06:26 +08:00

core

Fix typo in the data permission prompt (#909 )

2025-11-11 17:04:25 +08:00

database

Optimize redis batch get and delete operations (#899 )

2025-11-04 20:59:45 +08:00

locale

Add i18n support for response message (#753 )

2025-08-15 19:57:10 +08:00

middleware

Fix response status codes in the request logs (#905 )

2025-11-08 16:40:16 +08:00

plugin

Refactor foreign keys and relationships to pure logic (#901 )

2025-11-12 13:06:26 +08:00

scripts

Refactor foreign keys and relationships to pure logic (#901 )

2025-11-12 13:06:26 +08:00

sql

Optimize the data permission condition build (#904 )

2025-11-08 16:35:15 +08:00

static

Update the offline location information parse (#807 )

2025-09-11 14:49:09 +08:00

utils

Refactor foreign keys and relationships to pure logic (#901 )

2025-11-12 13:06:26 +08:00

__init__.py

Refactor foreign keys and relationships to pure logic (#901 )

2025-11-12 13:06:26 +08:00

.env.example

Update the primary database to postgresql (#829 )

2025-10-17 23:03:17 +08:00

.gitignore

Fix the log rule in gitignore (#571 )

2025-04-09 11:53:55 +08:00

alembic.ini

Add postgresql database support (#475 )

2024-12-25 22:04:04 +08:00

celery-start.sh

Add CLI support for startup celery services (#724 )

2025-07-16 12:28:57 +08:00

cli.py

Fix the import table cli command (#860 )

2025-10-17 13:02:28 +08:00

main.py

Update the ruff rules and format the code (#846 )

2025-10-10 19:02:49 +08:00

pre_start.sh

Add custom CLI for service startup (#697 )

2025-06-28 14:56:19 +08:00

README.md

Refactor foreign keys and relationships to pure logic (#901 )

2025-11-12 13:06:26 +08:00

run.py

Update the ruff rules and format the code (#846 )

2025-10-10 19:02:49 +08:00

README.md

FastAPI Best Architecture - Backend

Docker

Make sure you're at the root of the project

Run the following Docker command to build container:

docker build -f Dockerfile -t fba_backend_independent .

Start container

Native boot needs to change 127.0.0.1 in .env to host.docker.internal
```
docker run -d -p 8000:8000 --name fba_server fba_backend_independent
```

Contributing

Prerequisites
- Python >= 3.10
- Git
- uv
- Fork this repository to your GitHub account
Installation and setup

Clone your forked repository:
```
git clone https://github.com/<your account>/fastapi_best_architecture.git
```
Go to the root directory of the project, open the terminal, and run the following command:
```
uv sync --frozen
```
Checkout

Checkout a new branch and make your changes
```
git checkout -b your-new-feature-branch
```
Format and Lint

Auto-formatting and lint via prek
```
prek run --all-files
```
Commit and push

Commit your changes and push your branch to the GitHub.
PR

Create a PR via GitHub

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
celery-start.sh: For celery docker script, implementation is not recommended
scripts/format.sh: Perform ruff format check
scripts/lint.sh: Perform prek formatting
scripts/export.sh: Execute uv export dependency package