Update the README document (#214)

Author: wu-clan

README.md

@@ -1,21 +1,25 @@
 # FastAPI Best Architecture
 
+[![GitHub](https://img.shields.io/github/license/fastapi-practices/fastapi_best_architecture)](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE)
+[![Static Badge](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)
+
 English | [简体中文](./README.zh-CN.md)
 
-This is a base project for the FastAPI framework, using a pseudo three-tier architecture, **still in production**.
+FastAPI framework based on the front-end and back-end separation of the middle and back-end solutions, follow
+the [pseudo three-tier architecture](#pseudo-three-tier-architecture) design, support for **python3.10** and above
+versions
 
-It is intended to allow you to use it directly as your infrastructure to develop your project, this repository as a
-template library public, can be used directly
+Its purpose is to allow you to use it directly as the infrastructure of your new project, this repository as a template
+library open to any person or enterprise can be used for free!
 
-Support **python3.10** and above
+**Continuously updated and maintained**
 
 ## Pseudo three-tier architecture
 
-In python web frameworks, the mvc architecture is the most common, but for restful users, the three-tier architecture is
-the way to go
+The mvc architecture is a common design pattern in python web, but the three-tier architecture is even more fascinating.
 
-But in python development, there is no universal standard for the concept of a three-tier architecture, so here I call
-it a pseudo three-tier architecture
+In python web development, there is no common standard for the concept of three-tier architecture, so we'll call it a
+pseudo three-tier architecture here
 
 | workflow       | java           | fastapi_best_architecture |
 |----------------|----------------|---------------------------|
@@ -25,23 +29,60 @@ it a pseudo three-tier architecture
 | data access    | dao / mapper   | crud                      |
 | model          | model / entity | model                     |
 
+## Online preview
+
+Unfortunately, we don't have the funds to provide an online preview, you can deploy by checking
+out [local-development](#local-development), or directly using [Docker](#docker-deploy)
+to deploy, or at [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui)
+See a preview of some of the screenshots
+
 ## Features
 
-- [x] FastAPI new features
-- [x] Asynchronous design
-- [x] Restful API specification
-- [x] SQLAlchemy 2.0 syntax
-- [x] Pydantic data validation
-- [x] Casbin RBAC permission control
-- [x] APScheduler timed tasks
-- [x] JWT authentication
-- [x] Redis caching
-- [x] Docker deployment
-- [x] Pytest testing
+- [x] Design with FastAPI PEP 593 Annotated Parameters
+- [x] Global asynchronous design with async/await + asgiref
+- [x] Follows Restful API specification
+- [x] Global SQLAlchemy 2.0 syntax
+- [x] Casbin RBAC access control model
+- [x] APScheduler online timed tasks
+- [x] JWT middleware whitelist authentication
+- [x] Global customizable time zone time
+- [x] Docker / Docker-compose deployment
+- [x] Pytest Unit Testing
+
+TODO:
+
+1. [ ] Pydantic 2.0
+
+## Built-in features
+
+1. [x] User management: system user role management, permission assignment
+2. [x] Department Management: Configure the system organization (company, department, group...)
+3. [x] Menu Management: Configuration of system menus, user menus, button privilege identification
+4. [x] Role Management: Assign role menu privileges, assign role routing privileges
+5. [x] Dictionary Management: Maintain common fixed data or parameters within the system.
+6. [x] Operation Logs: logging and querying of normal and abnormal system operations.
+7. [x] Login Authentication: graphical authentication code background authentication login
+8. [x] Login Logs: Logging and querying of normal and abnormal user logins
+9. [x] Service Monitoring: server hardware device information and status
+10. [x] Timed Tasks: online task control (modify, delete, pause...)
+11. [x] Interface Documentation: Automatically generate online interactive API interface documentation.
+
+TODO:
 
-## Getting started:
+1. [ ] Dynamic Configuration: Dynamic configuration of the system environment (site title, logo, filing, footer...)
+2. [ ] code generation: according to the table structure, visualize the generation of additions, deletions,
+   modifications and checks of the business code.
+3. [ ] File Upload: Docking cloud OSS and local backup.
+4. [ ] System Notification: proactively send timed task notifications, resource warnings, service anomaly warnings...
 
-### 1: Legacy mode
+## Local development
+
+* Python: 3.10+
+* Mysql: 8.0+
+* Redis: The latest stable version is recommended
+* Nodejs: 14.0+
+
+### BackEnd
 
 1. Install dependencies
     ```shell
@@ -74,13 +115,17 @@ it a pseudo three-tier architecture
    # Execute the migration
    alembic upgrade head
     ```
-
-7. Execute the `backend/app/main.py` file to start the service
-8. Browser access: http://127.0.0.1:8000/api/v1/docs
+7. Modify the configuration file as needed
+8. Execute the `backend/app/main.py` file to start the service
+9. Browser access: http://127.0.0.1:8000/api/v1/docs
 
 ---
 
-### 2: Docker
+### Front
+
+Click [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) for details
+
+### Docker deploy
 
 1. Go to the directory where the ``docker-compose.yml`` file is located and create the environment variable
    file ``.env``
@@ -94,32 +139,39 @@ it a pseudo three-tier architecture
    cp .env.docker .env
    ```
 
-2. Execute the one-click boot command
+2. Modify the configuration file as needed
+3. Execute the one-click boot command
 
    ```shell
    docker-compose up -d -build
    ```
 
-3. Wait for the command to complete automatically
-4. Visit the browser: http://127.0.0.1:8000/api/v1/docs
+4. Wait for the command to complete automatically
+5. Visit the browser: http://127.0.0.1:8000/api/v1/docs
 
 ## Test data
 
 Initialize the test data using the `backend/sql/init_test_data.sql` file
 
-## Development
+## Development process
+
+For reference only
 
-Development process, for reference only
+### BackEnd
 
 1. Define the database model (model) and remember to perform database migration for each change
 2. Define the data validation model (schema)
 3. Define routes (router) and views (api)
 4. Define the business logic (service)
 5. Write database operations (crud)
 
+### Front
+
+Click [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) for details
+
 ## Test
 
-Execute tests via pytest
+Execute unittests via pytest
 
 1. Create the test database `fba_test`, select utf8mb4 encoding
 2. Enter the app directory
@@ -141,30 +193,35 @@ Execute tests via pytest
 <span style="margin: 0 5px;" ><a href="https://github.com/wu-clan" ><img src="https://images.weserv.nl/?url=avatars.githubusercontent.com/u/52145145?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" /></a></span>
 <span style="margin: 0 5px;" ><a href="https://github.com/downdawn" ><img src="https://images.weserv.nl/?url=avatars.githubusercontent.com/u/41266749?v=4&h=60&w=60&fit=cover&mask=circle&maxage=7d" /></a></span>
 
-## Thanks
+## Special thanks
 
 - [FastAPI](https://fastapi.tiangolo.com/)
 - [Pydantic](https://docs.pydantic.dev/latest/)
 - [SQLAlchemy](https://docs.sqlalchemy.org/en/20/)
 - [Casbin](https://casbin.org/zh/)
 - [Ruff](https://beta.ruff.rs/docs/)
-- ......
+- [Black](https://black.readthedocs.io/en/stable/index.html)
+- [RuoYi](http://ruoyi.vip/)
+- ...
 
-## Sponsor
+## Sponsor us
 
-> If this program has helped you, you can sponsor the author with some coffee beans :coffee:
+> If this program has helped you, you can sponsor us with some coffee beans :coffee:
 
 <table>
   <tr>
-    <td><img src="https://github.com/wu-clan/image/blob/master/pay/weixin.jpg?raw=true" width="180px"/>
-    <td><img src="https://github.com/wu-clan/image/blob/master/pay/zfb.jpg?raw=true" width="180px"/>
+    <td><img src="https://github.com/wu-clan/image/blob/master/pay/weixin.jpg?raw=true" width="180px" alt="WeChat"/>
+    <td><img src="https://github.com/wu-clan/image/blob/master/pay/zfb.jpg?raw=true" width="180px" alt="Alipay"/>
+    <td><img src="https://github.com/wu-clan/image/blob/master/pay/ERC20.jpg?raw=true" width="180px" alt="0x40D5e2304b452256afD9CE2d3d5531dc8d293138"/>
   </tr>
   <tr>
-    <td align="center">Wechat Pay</td>
+    <td align="center">WeChat Pay</td>
     <td align="center">Ali Pay</td>
+    <td align="center">ERC20</td>
   </tr>
 </table>
 
 ## License
 
-This project is licensed under the terms of the MIT license
+This project is licensed under the terms of
+the [MIT](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE) license