Skip to content

Commit b89b842

Browse files
committed
Optimize README
1 parent 19aeb51 commit b89b842

File tree

3 files changed

+68
-66
lines changed

3 files changed

+68
-66
lines changed

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66

77
English | [简体中文](./README.zh-CN.md)
88

9-
A backend and frontend separation solution based on the FastAPI framework, following
10-
the [pseudo 3-tier architecture](#pseudo-3-tier-architecture) design, supporting **Python 3.10** and above
11-
versions
9+
Enterprise-level backend architecture solution
1210

1311
**🔥Continuously updated and maintained🔥**
1412

@@ -49,37 +47,39 @@ pattern, use templates to transform it to your heart's content!
4947

5048
## Features
5149

52-
- [x] Design with FastAPI PEP 593 Annotated Parameters
53-
- [x] Global asynchronous design with async/await + asgiref
54-
- [x] Follows Restful API specification
55-
- [x] Global SQLAlchemy 2.0 syntax
56-
- [x] Pydantic v1 and v2 (different branches)
57-
- [x] Casbin RBAC access control model
58-
- [x] Role menu RBAC access control model
59-
- [x] Celery asynchronous tasks
60-
- [x] JWT middleware whitelist authentication
61-
- [x] Global customizable time zone time
62-
- [x] Docker / Docker-compose deployment
63-
- [x] Pytest Unit Testing
64-
65-
## Built-in features
66-
67-
- [x] User management: System User Role Management, Permission Allocation
68-
- [x] Department management: Configure system organization (company, department, team...)
69-
- [x] Menu management: Configure system menu, user menu, button permission tags
70-
- [x] Role management: role menu permission allocation, role route permission allocation
71-
- [x] Dictionary management: Maintain commonly used fixed data or parameters within the system
72-
- [x] Token management: System user online status detection, supports kicking users offline
73-
- [x] Login authentication: backend-based graphical captcha background authentication login
74-
- [x] Multipoint login: One-click modification of multipoint login through user information
75-
- [x] OAuth 2.0: Built-in self-developed OAuth 2.0 login integration
76-
- [x] Code generation: automatic backend code generation, supports preview, writing, and download
77-
- [x] Scheduled task: Automated task, asynchronous task, supports function calls
78-
- [x] Plugin system: Say goodbye to high coupling integration through hot-pluggable plugin mode
79-
- [x] Operation log: Record and query of system normal and abnormal operations
80-
- [x] Login log: Record and query of normal and abnormal user login
81-
- [x] Service monitoring: Server hardware device information and status
82-
- [x] API documentation: Automatically generate online interactive API documentation
50+
- [x] Global FastAPI PEP 593 Annotated parameter style
51+
- [x] Comprehensive async/await + asgiref asynchronous design
52+
- [x] Adheres to RESTful API specifications
53+
- [x] Uses SQLAlchemy 2.0 with new syntax
54+
- [x] Uses Pydantic v2 version
55+
- [x] Implements role-menu RBAC access control
56+
- [x] Integrates Casbin RBAC access control
57+
- [x] Supports Celery asynchronous tasks
58+
- [x] Custom-developed JWT authentication middleware
59+
- [x] Supports global custom time zones
60+
- [x] Supports Docker / Docker-compose deployment
61+
- [x] Integrates Pytest unit testing
62+
63+
## Built-in Functions
64+
65+
- [x] User Management: Assign roles and permissions
66+
- [x] Department Management: Configure organizational structure (company, department, team, etc.)
67+
- [x] Menu Management: Set up menus and button-level permissions
68+
- [x] Role Management: Configure roles, assign menus and permissions
69+
- [x] Dictionary Management: Maintain common parameters and configurations
70+
- [x] Parameter Management: Dynamically configure commonly used system parameters
71+
- [x] Notification Announcements: Publish and maintain system notification and announcement information
72+
- [x] Token Management: Detect online status, support forced logout
73+
- [x] Multi-device Login: Support one-click switching between multi-device login modes
74+
- [x] OAuth 2.0: Built-in custom-developed OAuth 2.0 authorization login
75+
- [x] Plugin System: Hot-swappable plugin design to reduce coupling
76+
- [x] Scheduled Tasks: Support scheduled, asynchronous tasks, and function calls
77+
- [x] Code Generation: Automatically generate code with preview, write, and download support
78+
- [x] Operation Logs: Record and query normal and abnormal operations
79+
- [x] Login Logs: Record and query normal and abnormal logins
80+
- [x] Cache Monitoring: Query system cache information and command statistics
81+
- [x] Service Monitoring: View server hardware information and status
82+
- [x] API Documentation: Automatically generate online interactive API documentation
8383

8484
## Development and deployment
8585

@@ -103,7 +103,7 @@ the [official documentation](https://fastapi-practices.github.io/fastapi_best_ar
103103

104104
## Interactivity
105105

106-
[TG / Discord](https://wu-clan.github.io/homepage/)
106+
[Discord](https://wu-clan.github.io/homepage/)
107107

108108
## Sponsor us
109109

README.zh-CN.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
简体中文 | [English](./README.md)
88

9-
基于 FastAPI 框架的前后端分离中后台解决方案,遵循[伪三层架构](#伪三层架构)设计, 支持 **python3.10** 及以上版本
9+
企业级后端架构解决方案
1010

1111
**🔥持续更新维护中🔥**
1212

@@ -43,38 +43,40 @@ mvc 架构作为常规设计模式,在 python web 中也很常见,但是三
4343
| 数据访问 | dao / mapper | crud |
4444
| 模型 | model / entity | model |
4545

46-
## 特征
46+
## 特性
4747

4848
- [x] 全局 FastAPI PEP 593 Annotated 参数风格
49-
- [x] async/await + asgiref 的全局异步设计
50-
- [x] 遵循 Restful API 规范
51-
- [x] 全局 SQLAlchemy 2.0 语法
52-
- [x] Pydantic v1 和 v2 (不同分支)
53-
- [x] Casbin RBAC 访问控制模型
54-
- [x] 角色菜单 RBAC 访问控制模型
55-
- [x] Celery 异步任务
56-
- [x] JWT 中间件白名单认证
57-
- [x] 全局自定义时区时间
58-
- [x] Docker / Docker-compose 部署
59-
- [x] Pytest 单元测试
49+
- [x] 全面 async/await + asgiref 异步设计
50+
- [x] 遵循 RESTful API 规范
51+
- [x] 使用 SQLAlchemy 2.0 全新语法
52+
- [x] 使用 Pydantic v2 版本
53+
- [x] 实现角色菜单 RBAC 访问控制
54+
- [x] 集成 Casbin RBAC 访问控制
55+
- [x] 支持 Celery 异步任务
56+
- [x] 自研 JWT 认证中间件
57+
- [x] 支持全局自定义时间时区
58+
- [x] 支持 Docker / Docker-compose 部署
59+
- [x] 集成 Pytest 单元测试
6060

6161
## 内置功能
6262

63-
- [x] 用户管理:系统用户角色管理,权限分配
64-
- [x] 部门管理:配置系统组织机构(公司、部门、小组...)
65-
- [x] 菜单管理:配置系统菜单,用户菜单,按钮权限标识
66-
- [x] 角色管理:角色菜单权限分配,角色路由权限分配
67-
- [x] 字典管理:维护系统内部常用固定数据或参数
68-
- [x] 令牌管理:系统用户在线状态检测,支持踢人下线
69-
- [x] 登录认证:基于后端的图形验证码后台认证登录
70-
- [x] 多端登录:通过用户信息一键修改多端登录支持
71-
- [x] OAuth20:内置自研 OAuth 2.0 登录集成
72-
- [x] 代码生成:后端代码自动生成,支持预览,写入及下载
73-
- [x] 定时任务:自动化任务,异步任务,支持函数调用
74-
- [x] 插件系统:通过热插拔插件模式告别高耦合集成
75-
- [x] 操作日志:系统正常和异常操作的日志记录与查询
76-
- [x] 登录日志:用户正常和异常登录的日志记录与查询
77-
- [x] 服务监控:服务器硬件设备信息与状态
63+
- [x] 用户管理:分配角色和权限
64+
- [x] 部门管理:配置组织架构(公司、部门、小组等)
65+
- [x] 菜单管理:设置菜单及按钮级权限
66+
- [x] 角色管理:配置角色、分配菜单和权限
67+
- [x] 字典管理:维护常用参数和配置
68+
- [x] 参数管理:系统常用参数动态配置
69+
- [x] 通知公告:发布和维护系统通知公告信息
70+
- [x] 令牌管理:检测在线状态,支持强制下线
71+
- [x] 多端登录:支持一键切换多端登录模式
72+
- [x] OAuth 2.0:内置自研 OAuth 2.0 授权登录
73+
- [x] 插件系统:热插拔插件设计,降低耦合
74+
- [x] 定时任务:支持定时,异步任务及函数调用
75+
- [x] 代码生成:自动生成代码,支持预览、写入和下载
76+
- [x] 操作日志:记录和查询正常和异常操作
77+
- [x] 登录日志:记录和查询正常和异常登录
78+
- [x] 缓存监控:查询系统缓存信息和命令统计
79+
- [x] 服务监控:查看服务器硬件信息和状态
7880
- [x] 接口文档:自动生成在线交互式 API 文档
7981

8082
## 开发部署
@@ -98,7 +100,7 @@ mvc 架构作为常规设计模式,在 python web 中也很常见,但是三
98100

99101
## 互动
100102

101-
[TG / Discord](https://wu-clan.github.io/homepage/)
103+
[Discord](https://wu-clan.github.io/homepage/)
102104

103105
## 赞助我们
104106

backend/app/admin/api/v1/sys/config.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121
router = APIRouter()
2222

2323

24-
@router.get('/website', summary='获取网站配置信息', dependencies=[DependsJwtAuth])
24+
@router.get('/website', summary='获取网站配置', dependencies=[DependsJwtAuth])
2525
async def get_website_config() -> ResponseSchemaModel[list[GetConfigDetail]]:
2626
config = await config_service.get_built_in_config('website')
2727
return response_base.success(data=config)
2828

2929

3030
@router.post(
3131
'/website',
32-
summary='保存网站配置信息',
32+
summary='保存网站配置',
3333
dependencies=[
3434
Depends(RequestPermission('sys:config:website:add')),
3535
DependsRBAC,

0 commit comments

Comments
 (0)