@@ -39,7 +39,8 @@ pattern, use templates to transform it to your heart's content!
3939You can view some of the preview screenshots
4040in [ fastapi_best_architecture_ui] ( https://github.com/fastapi-practices/fastapi_best_architecture_ui )
4141
42- Luckily, we now have a demo site: [ FBA UI] ( https://fba.xwboy.top/ )
42+ For the demo entrance, please refer
43+ to [ Official documentation] ( https://fastapi-practices.github.io/fastapi_best_architecture_docs/ )
4344
4445> tester: test / 123456
4546>
@@ -75,72 +76,11 @@ Luckily, we now have a demo site: [FBA UI](https://fba.xwboy.top/)
7576- [x] Timed tasks: automated tasks, asynchronous tasks, support for function calls
7677- [x] Interface Documentation: Automatically generate online interactive API interface documentation.
7778
78- ## Project structure
79-
80- ```
81- ├─📁 backend--------------- # Backend
82- │ ├─📁 alembic------------- # DB migration
83- │ ├─📁 app----------------- # Application
84- │ │ ├─📁 admin------------- # System admin
85- │ │ │ ├─📁 api------------- # Interface
86- │ │ │ ├─📁 crud------------ # CRUD
87- │ │ │ ├─📁 model----------- # SQLA model
88- │ │ │ ├─📁 schema---------- # Data transmit
89- │ │ │ ├─📁 service--------- # Service
90- │ │ │ └─📁 tests----------- # Pytest
91- │ │ ├─📁 generator--------- # Code generate
92- │ │ └─📁 task-------------- # Celery task
93- │ ├─📁 common-------------- # public resources
94- │ ├─📁 core---------------- # Core configuration
95- │ ├─📁 database------------ # Database connection
96- │ ├─📁 log----------------- # Log
97- │ ├─📁 middleware---------- # Middlewares
98- │ ├─📁 scripts------------- # Scripts
99- │ ├─📁 sql----------------- # SQL files
100- │ ├─📁 static-------------- # Static files
101- │ ├─📁 templates----------- # Template files
102- │ └─📁 utils--------------- # Toolkit
103- └─📁 deploy---------------- # Server deployment
104- ```
105-
106- ## Local development / Docker deployment
79+ ## Development and deployment
10780
10881For more details, please check
10982the [ official documentation] ( https://fastapi-practices.github.io/fastapi_best_architecture_docs/ )
11083
111- ## Test data
112-
113- Initialize the test data using the ` backend/sql/init_test_data.sql ` file.
114-
115- ## Development Process
116-
117- (For reference only)
118-
119- 1 . define the database model (model)
120- 2 . define the data validation model (schema)
121- 3 . define the view (api) and routing (router)
122- 4 . write business (service)
123- 5 . write database operations (crud)
124-
125- ## Testing
126-
127- Execute unit tests through ` pytest ` .
128-
129- 1 . create a test database ` fba_test ` with utf8mb4 encoding
130- 2 . create database tables using the ` backend/sql/create_tables.sql ` file
131- 3 . initialize the test data using the ` backend/sql/init_pytest_data.sql ` file
132- 4 . Go to the ` backend ` directory and execute the test commands.
133-
134- ``` shell
135- cd backend/
136-
137- pytest -vs --disable-warnings
138- ```
139-
140- ## Status
141-
142- ![ Alt] ( https://repobeats.axiom.co/api/embed/b2174ef1abbebaea309091f1c998fc97d0c1536a.svg " Repo beats analytics image ")
143-
14484## Contributors
14585
14686<a href =" https://github.com/fastapi-practices/fastapi_best_architecture/graphs/contributors " >
0 commit comments