diff --git a/README.md b/README.md index 71817cfe..dff81c21 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ TODO: 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...) +10. [x] Scheduled tasks: automated tasks, asynchronous tasks, and function invocation are supported 11. [x] Interface Documentation: Automatically generate online interactive API interface documentation. TODO: @@ -123,7 +123,7 @@ TODO: # Optional, if you don't need to use the scheduled task celery -A tasks beat --loglevel=INFO ``` - + 8. Modify the configuration file as needed 9. Execute the `backend/app/main.py` file to start the service 10. Browser access: http://127.0.0.1:8000/api/v1/docs @@ -132,13 +132,13 @@ TODO: ### Front -Click [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) for details +Go to [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) for details ### Docker deploy > [!WARNING] -> Default port conflict:8000,3306,6379,5672 -> +> Default port conflict:8000,3306,6379,5672 +> > As a best practice, shut down on-premises services before deployment:mysql,redis,rabbitmq... 1. Go to the directory where the ``docker-compose.yml`` file is located and create the environment variable @@ -181,7 +181,7 @@ For reference only ### Front -Click [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) for details +Go to [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) for details ## Test @@ -214,13 +214,24 @@ Execute unittests via pytest - [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/) - ... +## 互动 + +有且仅有当前一个频道,请注意辨别真伪 + + + + + + + + +
直链跳转
Telegram
+ ## Sponsor us -> If this program has helped you, you can sponsor us with some coffee beans :coffee: +If this program has helped you, you can sponsor us with some coffee beans :coffee: diff --git a/README.zh-CN.md b/README.zh-CN.md index 549bf761..bdf50e95 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -25,6 +25,12 @@ mvc 架构作为常规设计模式,在 python web 中也很常见,但是三 | 数据访问 | dao / mapper | crud | | 模型 | model / entity | model | +## 在线预览 + +遗憾的是,我们没有资金提供在线预览,您可以通过查看[本地开发](#本地开发)进行部署,或直接使用 [Docker](#docker-部署) +进行部署,或者在 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) +查看部分截图预览 + ## 特征 - [x] 使用 FastAPI PEP 593 Annotated 参数设计 @@ -53,7 +59,7 @@ TODO: 7. [x] 登录认证:图形验证码后台认证登录 8. [x] 登录日志:用户正常登录和异常登录的日志记录与查询 9. [x] 服务监控:服务器硬件设备信息与状态 -10. [x] 定时任务:在线任务控制(修改,删除,暂停...) +10. [x] 定时任务:自动化任务,异步任务,支持函数调用 11. [x] 接口文档:自动生成在线交互式 API 接口文档 TODO: @@ -63,12 +69,6 @@ TODO: 3. [ ] 文件上传:对接云OSS加本地备份 4. [ ] 系统通知:主动发送定时任务通知,资源警告,服务异常预警... -## 在线预览 - -遗憾的是,我们没有资金提供在线预览,您可以通过查看[本地开发](#本地开发)进行部署,或直接使用 [Docker](#docker-部署) -进行部署,或者在 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) -查看部分截图预览 - ## 本地开发 * Python 3.10+ @@ -127,7 +127,7 @@ TODO: ### 前端 -点击 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 查看详情 +跳转 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 查看详情 ### Docker 部署 @@ -175,7 +175,7 @@ TODO: ### 前端 -点击 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 查看详情 +跳转 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 查看详情 ## 测试 @@ -208,13 +208,24 @@ TODO: - [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/) - ... +## 互动 + +有且仅有当前一个频道,请注意辨别真伪 + +
+ + + + + + +
直链跳转
Telegram
+ ## 赞助我们 -> 如果此项目能够帮助到你,你可以赞助我们一些咖啡豆表示鼓励 :coffee: +如果此项目能够帮助到你,你可以赞助作者一些咖啡豆表示鼓励 :coffee: