Skip to content

Commit 7443d3e

Browse files
committed
update docs
1 parent 0d1e24e commit 7443d3e

File tree

3 files changed

+47
-46
lines changed

3 files changed

+47
-46
lines changed

docs/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,33 +27,33 @@ config:
2727
- type: SponsorHome
2828
- type: features
2929
features:
30-
- title: 最新技术栈
30+
- title: 现代技术栈
3131
icon:
32-
details: 基于 FastAPISQLAlchemy 2.0Pydantic-v2、Celery 等技术栈
33-
- title: 自研架构
32+
details: FastAPI + SQLAlchemy 2.0 + Pydantic v2 + Celery 全栈异步
33+
- title: 自研伪三层架构
3434
icon: 🧠
35-
details: 独特的「伪三层架构」,让所有开发者可轻松驾驭
36-
- title: 插件系统
35+
details: 极简设计,所有开发者都能轻松上手与扩展
36+
- title: 自研插件系统
3737
icon: unjs:unplugin
38-
details: 告别高耦合集成,让功能变得可轻松 Hot Swap(热插拔)
39-
- title: JWT
38+
details: 零耦合功能扩展,支持随意拼装
39+
- title: 高性能 JWT
4040
icon: 🔏
41-
details: 带有缓存和白名单的 JWT 授权中间件
42-
- title: 权限管理
41+
details: 内置缓存 + 白名单机制的自研认证中间件
42+
- title: 高级权限控制
4343
icon: 🛠️
44-
details: RBAC 解决方案和十分高级的数据权限
45-
- title: 代码生成
44+
details: 完整 RBAC + 精细化数据权限方案
45+
- title: 内置代码生成器
4646
icon: ⚙️
47-
details: 内置代码自动生成,告别通用代码频繁 cv
48-
- title: 时区时间
47+
details: 一键生成代码,预览、写入、下载,告别重复 CV
48+
- title: 全局时区支持
4949
icon:
50-
details: 提供全局时区时间配置,告别时间处理烦恼
51-
- title: 日志
50+
details: 开箱即用的时区配置,彻底解决时间处理痛点
51+
- title: 全链路日志追踪
5252
icon: 📝
53-
details: 强大的日志系统,Trace ID 助你轻松定位任何问题
54-
- title: Docker
53+
details: Trace ID + 丰富日志,快速定位任何问题
54+
- title: 一键容器部署
5555
icon: 🐳
56-
details: 提供 Docker compose 一键部署方案
56+
details: 完整 Docker Compose 方案,极速上线
5757
- type: custom
5858
---
5959

docs/backend/summary/intro.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -26,38 +26,39 @@ mvc 架构作为常规设计模式,在 python web 中很常见,但是三层
2626

2727
## 特性
2828

29-
- [x] 全局 FastAPI PEP 593 Annotated 参数风格
30-
- [x] 全面 async/await + asgiref 异步设计
29+
- [x] 全局 PEP 593 Annotated 参数注入
30+
- [x] 全异步设计(async/await + asgiref
3131
- [x] 遵循 RESTful API 规范
32-
- [x] 使用 SQLAlchemy 2.0 全新语法
33-
- [x] 使用 Pydantic v2 版本
34-
- [x] 角色菜单 RBAC 访问控制
35-
- [x] 支持 Celery 异步任务
36-
- [x] 自研 JWT 认证中间件
37-
- [x] 支持全局自定义时间时区
38-
- [x] 支持 Docker / Docker-compose 部署
32+
- [x] SQLAlchemy 2.0 现代语法
33+
- [x] Pydantic v2 全栈数据验证
34+
- [x] 角色菜单 RBAC 权限控制
35+
- [x] 原生 Celery 异步任务支持
36+
- [x] 自研高性能 JWT 认证中间件
37+
- [x] 全局自定义时区处理
38+
- [x] 一键 Docker / Docker-Compose 部署
3939
- [x] 集成 Pytest 单元测试
40+
- [x] Grafana 全链路可观测性
4041

4142
## 内置功能
4243

43-
- [x] 用户管理:分配角色和权限
44-
- [x] 部门管理:配置组织架构(公司、部门、小组等)
45-
- [x] 菜单管理:设置菜单及按钮级权限
46-
- [x] 角色管理:配置角色、分配菜单和权限
47-
- [x] 字典管理:维护常用参数和配置
48-
- [x] 参数管理:系统常用参数动态配置
49-
- [x] 通知公告:发布和维护系统通知公告信息
50-
- [x] 令牌管理:检测在线状态,支持强制下线
51-
- [x] 多端登录:支持一键切换多端登录模式
52-
- [x] OAuth 2.0:内置自研 OAuth 2.0 授权登录
53-
- [x] 插件系统:热插拔插件设计,降低耦合
54-
- [x] 定时任务:支持定时,异步任务及函数调用
55-
- [x] 代码生成:自动生成代码,支持预览、写入和下载
56-
- [x] 操作日志:记录和查询正常和异常操作
57-
- [x] 登录日志:记录和查询正常和异常登录
58-
- [x] 缓存监控:查询系统缓存信息和命令统计
59-
- [x] 服务监控:查看服务器硬件信息和状态
60-
- [x] 接口文档:自动生成在线交互式 API 文档
44+
- [x] 用户管理:灵活分配角色与权限
45+
- [x] 部门管理:轻松构建组织架构
46+
- [x] 菜单管理:精准到按钮级的权限配置
47+
- [x] 角色管理:一站式角色权限分配
48+
- [x] 字典管理:全局参数统一维护
49+
- [x] 参数管理:运行时动态配置系统参数
50+
- [x] 通知公告:快速发布系统消息
51+
- [x] 令牌管理:实时在线监测 + 强制下线
52+
- [x] 多端登录:一键切换多终端模式
53+
- [x] 自研 OAuth 2.0:开箱即用授权登录
54+
- [x] 插件系统:零耦合扩展,随意拼装
55+
- [x] 定时任务:灵活调度异步任务
56+
- [x] 代码生成:一键预览、写入、下载
57+
- [x] 操作日志:完整记录正常/异常操作
58+
- [x] 登录日志:详尽追踪登录行为
59+
- [x] 缓存监控:实时查看缓存统计
60+
- [x] 服务监控:服务器硬件与状态一目了然
61+
- [x] 接口文档:自动生成交互式 Swagger 文档
6162

6263
## 项目结构
6364

docs/plugin/before.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: 前言
88

99
## 愿景
1010

11-
提供一个共创平台,告别高耦合集成,让功能变得可轻松 Hot Swap(热插拔)
11+
提供一个共创平台,告别高耦合集成,让功能变得像乐高一样随意拼装
1212

1313
遗憾的是,我们并不会提供插件管理平台对插件进行统一管理,我们计划将所有插件在 [插件市场](../market.md) 进行展示和导航
1414

0 commit comments

Comments
 (0)