Skip to content

Commit 8c2e324

Browse files
committed
doc: readme.md
1 parent 48aebec commit 8c2e324

1 file changed

Lines changed: 37 additions & 45 deletions

File tree

README.md

Lines changed: 37 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@
1212
<a href="https://deepwiki.com/wkylin/pro-react-admin"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki" /></a>
1313
</div>
1414

15-
## 🚀 Pro React Admin
15+
## <span role="img" aria-label="rocket">🚀</span> Pro React Admin
1616

1717
**Pro React Admin** 是一款基于 **React v19** 的高性能、企业级中后台前端解决方案。深度整合 **RBAC 动态权限****KeepAlive 缓存****多标签页****AI 智能助手**。提供开箱即用的国际化、暗黑模式、Mock 数据与 E2E 测试体系,助力开发者快速构建稳健、安全的 SaaS 平台与数据可视化系统。具备双重架构设计,既是完整的企业级应用,也是可发布的组件库 @w.ui/wui-react。
1818

1919
---
2020

21-
## 🌐 在线预览
21+
## <span role="img" aria-label="globe">🌐</span> 在线预览
2222

2323
- **主应用 (Main App)**: [https://wkylin.github.io/pro-react-admin/](https://wkylin.github.io/pro-react-admin/)
2424
- **主应用 (Vercel App)**: [https://pro-react-admin.vercel.app/](https://pro-react-admin.vercel.app/)
@@ -27,46 +27,46 @@
2727

2828
---
2929

30-
## 🏆 项目亮点
30+
## <span role="img" aria-label="trophy">🏆</span> 项目亮点
3131

32-
- **🚀 极致性能体验**:基于 **React 19** 构建,重构 `KeepAlive` 缓存机制(采用 CSS 显隐策略替代 DOM 移动,大幅减少重排),配合 `useTransition` 实现丝滑的 Tab 切换与交互响应。
33-
- **🧩 丰富组件生态**:沉淀 **120+** 高质量业务组件,支持 **独立打包发布 (@w.ui/wui-react)**。集成 **Storybook** 实现组件可视化开发与文档管理,显著提升复用效率。
34-
- **🛡️ 企业级权限体系**:完善的 **RBAC** 模型,支持路由、菜单、按钮级细粒度权限控制。内置路由自动过滤、`useSafeNavigate` 防越权跳转,保障系统安全。
35-
- **⚡️ 前沿技术栈**:采用 **TypeScript v5** + **Ant Design v6** + **Vite v7/Webpack v5** 双构建模式,紧跟社区最新标准,提供最佳开发体验。
36-
- **🤖 AI 智能化集成**:内置 ChatGPT 演示(支持 SSE 流式响应)、Markmap 思维导图生成、Mermaid 流程图渲染,探索 AI 在后台管理中的应用场景。
37-
- **🧪 全链路质量保障**:集成 **Playwright** E2E 自动化测试,配合 Mock Service Worker (MSW) 实现真实的网络模拟与多角色权限切换测试。
38-
- **📱 极致移动端适配**:精心打磨的响应式布局,从 PC 到手机端提供一致的流畅体验。
32+
- **<span role="img" aria-label="rocket">🚀</span> 极致性能体验**:基于 **React 19** 构建,重构 `KeepAlive` 缓存机制(采用 CSS 显隐策略替代 DOM 移动,大幅减少重排),配合 `useTransition` 实现丝滑的 Tab 切换与交互响应。
33+
- **<span role="img" aria-label="puzzle">🧩</span> 丰富组件生态**:沉淀 **120+** 高质量业务组件,支持 **独立打包发布 (@w.ui/wui-react)**。集成 **Storybook** 实现组件可视化开发与文档管理,显著提升复用效率。
34+
- **<span role="img" aria-label="shield">🛡️</span> 企业级权限体系**:完善的 **RBAC** 模型,支持路由、菜单、按钮级细粒度权限控制。内置路由自动过滤、`useSafeNavigate` 防越权跳转,保障系统安全。
35+
- **<span role="img" aria-label="zap">⚡️</span> 前沿技术栈**:采用 **TypeScript v5** + **Ant Design v6** + **Vite v7/Webpack v5** 双构建模式,紧跟社区最新标准,提供最佳开发体验。
36+
- **<span role="img" aria-label="robot">🤖</span> AI 智能化集成**:内置 ChatGPT 演示(支持 SSE 流式响应)、Markmap 思维导图生成、Mermaid 流程图渲染,探索 AI 在后台管理中的应用场景。
37+
- **<span role="img" aria-label="test-tube">🧪</span> 全链路质量保障**:集成 **Playwright** E2E 自动化测试,配合 Mock Service Worker (MSW) 实现真实的网络模拟与多角色权限切换测试。
38+
- **<span role="img" aria-label="mobile">📱</span> 极致移动端适配**:精心打磨的响应式布局,从 PC 到手机端提供一致的流畅体验。
3939

40-
- **📦 CI/CD 集成** :GitHub Actions:自动构建部署到 GitHub Pages. Sentry 集成:可选的错误监控与源码上传
40+
- **<span role="img" aria-label="gear">⚙️</span> CI/CD 集成** :GitHub Actions:自动构建部署到 GitHub Pages. Sentry 集成:可选的错误监控与源码上传
4141
---
4242

43-
## 🔑 核心功能
43+
## <span role="img" aria-label="key">🔑</span> 核心功能
4444

45-
- 🔐 **动态权限引擎**:登录后根据角色(Admin/Manager/Business/User)自动生成路由表,非权限路由自动拦截(403/404)。
46-
- 📑 **高性能多标签页**:支持 `ProTabs` 多页签切换,状态持久化保持,支持右键菜单(关闭其他/关闭所有/刷新)。
47-
- 📚 **组件文档库**:集成 Storybook,提供 120+ 组件的交互式文档与预览,支持 Props 动态调试与独立测试。
48-
- 📡 **健壮请求层**:封装统一请求库,支持并发控制、自动重试、取消重复请求、全局错误处理与消息去重。
49-
- 👤 **登录/注册流程**:完整的登录鉴权流程,支持一键测试账号切换,实时同步权限状态。
50-
- 📊 **数据可视化**:集成 ECharts、Recharts 等多种图表库,支持大数据量展示。
51-
- 📝 **富文本与文档**:支持 Markdown 实时渲染与编辑、代码高亮、数学公式解析。
52-
- 🎬 **多媒体支持**:内置音频/视频播放器,支持 Tab 切换自动暂停/恢复播放,优化资源占用。
53-
- 🌍 **主题与国际化**:内置明亮/暗黑模式一键切换,支持多语言(i18n)动态切换。
54-
- 🎭 **Mock 数据模拟**:基于 Faker.js 和 MSW 的纯前端 Mock 方案,脱离后端独立开发。
55-
- 📦 **组件库发布**:支持将 `src/components` 独立打包为 NPM 库 (`@w.ui/wui-react`),提供 ESM/UMD 格式,支持按需加载与类型提示。
45+
- <span role="img" aria-label="locked">🔐</span> **动态权限引擎**:登录后根据角色(Admin/Manager/Business/User)自动生成路由表,非权限路由自动拦截(403/404)。
46+
- <span role="img" aria-label="bookmark-tabs">📑</span> **高性能多标签页**:支持 `ProTabs` 多页签切换,状态持久化保持,支持右键菜单(关闭其他/关闭所有/刷新)。
47+
- <span role="img" aria-label="books">📚</span> **组件文档库**:集成 Storybook,提供 120+ 组件的交互式文档与预览,支持 Props 动态调试与独立测试。
48+
- <span role="img" aria-label="satellite">📡</span> **健壮请求层**:封装统一请求库,支持并发控制、自动重试、取消重复请求、全局错误处理与消息去重。
49+
- <span role="img" aria-label="bust-in-silhouette">👤</span> **登录/注册流程**:完整的登录鉴权流程,支持一键测试账号切换,实时同步权限状态。
50+
- <span role="img" aria-label="bar-chart">📊</span> **数据可视化**:集成 ECharts、Recharts 等多种图表库,支持大数据量展示。
51+
- <span role="img" aria-label="memo">📝</span> **富文本与文档**:支持 Markdown 实时渲染与编辑、代码高亮、数学公式解析。
52+
- <span role="img" aria-label="clapper-board">🎬</span> **多媒体支持**:内置音频/视频播放器,支持 Tab 切换自动暂停/恢复播放,优化资源占用。
53+
- <span role="img" aria-label="earth">🌍</span> **主题与国际化**:内置明亮/暗黑模式一键切换,支持多语言(i18n)动态切换。
54+
- <span role="img" aria-label="test-tube">🧪</span> **Mock 数据模拟**:基于 Faker.js 和 MSW 的纯前端 Mock 方案,脱离后端独立开发。
55+
- <span role="img" aria-label="package">📦</span> **组件库发布**:支持将 `src/components` 独立打包为 NPM 库 (`@w.ui/wui-react`),提供 ESM/UMD 格式,支持按需加载与类型提示。
5656

5757
---
5858

59-
## 📦 技术栈
59+
## <span role="img" aria-label="toolbox">🧰</span> 技术栈
6060

61-
- ⚛️ **Core**: React v19 / TypeScript v5
62-
- 🎨 **UI**: Ant Design v6
63-
- 🛣️ **Router**: React Router v7
64-
- **Build**: Vite v7 / Webpack v5
65-
- 🧪 **Test**: Playwright / Jest / Testing Library
66-
- 🎭 **Mock**: Mock Server(Faker/MSW)
67-
- 📏 **Lint**: ESLint / Prettier / Husky / Commitizen
68-
- 🔍 **Quality**: Sentry / SonarQube / DeepScan
69-
- 🐳 **Deploy**: Docker / Nginx / Github Actions
61+
- <span role="img" aria-label="atom">⚛️</span> **Core**: React v19 / TypeScript v5
62+
- <span role="img" aria-label="art">🎨</span> **UI**: Ant Design v6
63+
- <span role="img" aria-label="compass">🧭</span> **Router**: React Router v7
64+
- <span role="img" aria-label="zap">⚡</span> **Build**: Vite v7 / Webpack v5
65+
- <span role="img" aria-label="test-tube">🧪</span> **Test**: Playwright / Jest / Testing Library
66+
- <span role="img" aria-label="test-tube">🧪</span> **Mock**: Mock Server(Faker/MSW)
67+
- <span role="img" aria-label="straight-ruler">📏</span> **Lint**: ESLint / Prettier / Husky / Commitizen
68+
- <span role="img" aria-label="magnifying-glass">🔍</span> **Quality**: Sentry / SonarQube / DeepScan
69+
- <span role="img" aria-label="whale">🐳</span> **Deploy**: Docker / Nginx / Github Actions
7070

7171
---
7272

@@ -139,7 +139,7 @@ npm run dev
139139
---
140140

141141

142-
## 🛡️ 技术架构
142+
## 🏗️ 技术架构
143143

144144
<img width="1903" height="387" alt="Snipaste_2025-12-31_09-14-38" src="https://github.com/user-attachments/assets/915ba91a-8852-4dc0-8a14-091e781d9f04" />
145145

@@ -153,7 +153,7 @@ npm run dev
153153
154154
Baize CLI 是一个轻量、规范且高效的前端项目脚手架工具,旨在帮助开发者快速搭建基于 React、Vue 等现代框架的标准化项目结构。
155155

156-
- 🚀 快速启动:秒级生成项目模板,开箱即用。
156+
- <span role="img" aria-label="rocket">🚀</span> 快速启动:秒级生成项目模板,开箱即用。
157157
- 🛠 规范集成:内置 ESLint、Prettier 等代码规范配置。
158158
- 🎨 交互友好:优雅的命令行交互体验。
159159
- 🌏 线上地址:[Baize](https://www.npmjs.com/package/baize-cli)
@@ -179,7 +179,7 @@ Baize CLI 是一个轻量、规范且高效的前端项目脚手架工具,旨
179179

180180
---
181181

182-
## 🤝 贡献指南
182+
## 📖 贡献指南
183183

184184
欢迎 PR、Issue 与 Star!
185185

@@ -197,21 +197,13 @@ Apache-2.0 © [wkylin](https://github.com/wkylin)
197197

198198
---
199199

200-
## 🧩 约定式提交
200+
## 📝 约定式提交
201201

202202
1. [约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/)
203203
2. [语义化版本 2.0.0](https://semver.org/lang/zh-CN/)
204204

205205
---
206206

207-
208-
## 🤝 Show your support
209-
210-
If you like the project, give it a star ⭐️, it will be a great encouragement to me.
211-
212-
---
213-
214-
215207
## ⭐️ Star History
216208

217209
[![Star History Chart](https://api.star-history.com/svg?repos=wkylin/pro-react-admin&type=Date)](https://star-history.com/#wkylin/pro-react-admin&Date)

0 commit comments

Comments
 (0)