diff --git a/README.md b/README.md index ec16dc9f..e7aa1c4c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ English | [简体中文](./README.zh-CN.md) A backend and frontend separation solution based on the FastAPI framework, following -the [pseudo three-tier architecture](#pseudo-three-tier-architecture) design, supporting **Python 3.10** and above +the [pseudo 3-tier architecture](#pseudo-3-tier-architecture) design, supporting **Python 3.10** and above versions **🔥Continuously updated and maintained🔥** @@ -29,12 +29,12 @@ versions > [!NOTE] > This repository as a template library open to any person or enterprise can be used for free! -## Pseudo three-tier architecture +## Pseudo 3-tier architecture -The mvc architecture is a common design pattern in python web, but the three-tier architecture is even more fascinating +The mvc architecture is a common design pattern in python web, but the 3-tier architecture is even more fascinating -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 +In python web development, there is no common standard for the concept of 3-tier architecture, so we'll call it a +pseudo 3-tier architecture here But please note that we don't have a traditional multi-app structure (django, springBoot...) If you don't like this pattern, use templates to transform it to your heart's content! @@ -64,19 +64,22 @@ pattern, use templates to transform it to your heart's content! ## Built-in features -- [x] User management: management of system user roles, assignment of permissions -- [x] Departmental management: Configuration of the system organization (company, department, group, ...) -- [x] Menu management: Configuration of system menus, user menus, button permission labels -- [x] Role management: assignment of role menu privileges, assignment of role routing privileges -- [x] Dictionary management: maintenance of commonly used fixed data or parameters within the system -- [x] Token management:System user online status detection, supports kicking user offline -- [x] Code generation: back-end code is automatically generated, supporting preview, write and download. -- [x] Operation log: logging and querying of normal and abnormal system operations. -- [x] Login authentication: graphical captcha backend authentication login -- [x] Logging: logging and querying of normal and abnormal user logins -- [x] Service monitoring: server hardware device information and status -- [x] Timed tasks: automated tasks, asynchronous tasks, support for function calls -- [x] Interface Documentation: Automatically generate online interactive API interface documentation. +- [x] User management: System User Role Management, Permission Allocation +- [x] Department management: Configure system organization (company, department, team...) +- [x] Menu management: Configure system menu, user menu, button permission tags +- [x] Role management: role menu permission allocation, role route permission allocation +- [x] Dictionary management: Maintain commonly used fixed data or parameters within the system +- [x] Token management: System user online status detection, supports kicking users offline +- [x] Login authentication: backend-based graphical captcha background authentication login +- [x] Multipoint login: One-click modification of multipoint login through user information +- [x] OAuth 2.0: Built-in self-developed OAuth 2.0 login integration +- [x] Code generation: automatic backend code generation, supports preview, writing, and download +- [x] Scheduled task: Automated task, asynchronous task, supports function calls +- [x] Plugin system: Say goodbye to high coupling integration through hot-pluggable plugin mode +- [x] Operation log: Record and query of system normal and abnormal operations +- [x] Login log: Record and query of normal and abnormal user login +- [x] Service monitoring: Server hardware device information and status +- [x] API documentation: Automatically generate online interactive API documentation ## Development and deployment diff --git a/README.zh-CN.md b/README.zh-CN.md index b73e0c96..209e62c7 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -45,7 +45,7 @@ mvc 架构作为常规设计模式,在 python web 中也很常见,但是三 ## 特征 -- [x] 使用 FastAPI PEP 593 Annotated 参数设计 +- [x] 全局 FastAPI PEP 593 Annotated 参数风格 - [x] async/await + asgiref 的全局异步设计 - [x] 遵循 Restful API 规范 - [x] 全局 SQLAlchemy 2.0 语法 @@ -66,13 +66,16 @@ mvc 架构作为常规设计模式,在 python web 中也很常见,但是三 - [x] 角色管理:角色菜单权限分配,角色路由权限分配 - [x] 字典管理:维护系统内部常用固定数据或参数 - [x] 令牌管理:系统用户在线状态检测,支持踢人下线 +- [x] 登录认证:基于后端的图形验证码后台认证登录 +- [x] 多点登录:通过用户信息一键修改多点登录支持 +- [x] OAuth20:内置自研 OAuth 2.0 登录集成 - [x] 代码生成:后端代码自动生成,支持预览,写入及下载 +- [x] 定时任务:自动化任务,异步任务,支持函数调用 +- [x] 插件系统:通过热插拔插件模式告别高耦合集成 - [x] 操作日志:系统正常和异常操作的日志记录与查询 -- [x] 登录认证:图形验证码后台认证登录 - [x] 登录日志:用户正常和异常登录的日志记录与查询 - [x] 服务监控:服务器硬件设备信息与状态 -- [x] 定时任务:自动化任务,异步任务,支持函数调用 -- [x] 接口文档:自动生成在线交互式 API 接口文档 +- [x] 接口文档:自动生成在线交互式 API 文档 ## 开发部署