Skip to content

Commit 2f76988

Browse files
authored
Add the deepwiki badge to README (#623)
1 parent b275481 commit 2f76988

File tree

2 files changed

+6
-86
lines changed

2 files changed

+6
-86
lines changed

README.md

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44

55
# FastAPI Best Architecture
66

7-
English | [简体中文](./README.zh-CN.md)
8-
97
Enterprise-level backend architecture solution
108

11-
**🔥Continuously updated and maintained🔥**
9+
English | [简体中文](./README.zh-CN.md)
1210

1311
[![GitHub](https://img.shields.io/github/license/fastapi-practices/fastapi_best_architecture)](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE)
1412
[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)
@@ -21,12 +19,10 @@ Enterprise-level backend architecture solution
2119
![Docker](https://img.shields.io/badge/Docker-%232496ED?logo=docker&logoColor=white)
2220
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.com/invite/yNN3wTbVAC)
2321
![Discord](https://img.shields.io/discord/1185035164577972344)
22+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/fastapi-practices/fastapi_best_architecture)
2423

2524
</div>
2625

27-
> [!NOTE]
28-
> This repository as a template library open to any person or enterprise can be used for free!
29-
3026
## Pseudo 3-tier architecture
3127

3228
The mvc architecture is a common design pattern in python web, but the 3-tier architecture is even more fascinating
@@ -45,43 +41,7 @@ pattern, use templates to transform it to your heart's content!
4541
| data access | dao / mapper | crud |
4642
| model | model / entity | model |
4743

48-
## Features
49-
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
83-
84-
## Development and deployment
44+
## Help
8545

8646
For more details, please check
8747
the [official documentation](https://fastapi-practices.github.io/fastapi_best_architecture_docs/)

README.zh-CN.md

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44

55
# FastAPI Best Architecture
66

7-
简体中文 | [English](./README.md)
8-
97
企业级后端架构解决方案
108

11-
**🔥持续更新维护中🔥**
9+
简体中文 | [English](./README.md)
1210

1311
[![GitHub](https://img.shields.io/github/license/fastapi-practices/fastapi_best_architecture)](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE)
1412
[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)
@@ -21,12 +19,10 @@
2119
![Docker](https://img.shields.io/badge/Docker-%232496ED?logo=docker&logoColor=white)
2220
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.com/invite/yNN3wTbVAC)
2321
![Discord](https://img.shields.io/discord/1185035164577972344)
22+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/fastapi-practices/fastapi_best_architecture)
2423

2524
</div>
2625

27-
> [!NOTE]
28-
> 此仓库作为模板库公开,任何人或企业均可免费使用!
29-
3026
## 伪三层架构
3127

3228
mvc 架构作为常规设计模式,在 python web 中也很常见,但是三层架构更令人着迷
@@ -43,43 +39,7 @@ mvc 架构作为常规设计模式,在 python web 中也很常见,但是三
4339
| 数据访问 | dao / mapper | crud |
4440
| 模型 | model / entity | model |
4541

46-
## 特性
47-
48-
- [x] 全局 FastAPI PEP 593 Annotated 参数风格
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 单元测试
60-
61-
## 内置功能
62-
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] 服务监控:查看服务器硬件信息和状态
80-
- [x] 接口文档:自动生成在线交互式 API 文档
81-
82-
## 开发部署
42+
## 帮助
8343

8444
更多详情请查看 [官方文档](https://fastapi-practices.github.io/fastapi_best_architecture_docs/)
8545

0 commit comments

Comments
 (0)