|
|
@@ -1,10 +1,93 @@
|
|
|
-# 冠客微信管理后台
|
|
|
+# WeChat UI
|
|
|
|
|
|
-## 安装
|
|
|
-> pnpm install
|
|
|
+基于 Vue 3 + TypeScript + Vite + Ant Design Vue 的微信管理系统前端项目。
|
|
|
|
|
|
-## 开发
|
|
|
-> pnpm dev
|
|
|
+## 技术栈
|
|
|
|
|
|
-## 编译
|
|
|
-> pnpm build
|
|
|
+- 核心框架：Vue 3
|
|
|
+- 开发语言：TypeScript
|
|
|
+- 构建工具：Vite 5
|
|
|
+- UI 框架：Ant Design Vue 4
|
|
|
+- 状态管理：Pinia
|
|
|
+- 路由管理：Vue Router 4
|
|
|
+- 包管理器：pnpm
|
|
|
+- 代码规范：ESLint + Prettier + StyleLint
|
|
|
+- Git 提交规范：Commitizen + Husky
|
|
|
+- 国际化：vue-i18n
|
|
|
+- 图表：ECharts
|
|
|
+- 富文本编辑器：TinyMCE
|
|
|
+- 代码编辑器：CodeMirror
|
|
|
+
|
|
|
+## 项目特性
|
|
|
+
|
|
|
+- 🚀 使用 Vue 3 + TypeScript + Vite 等最新技术栈
|
|
|
+- 📦 基于 pnpm + workspace 的 monorepo 项目结构
|
|
|
+- 🎨 集成了 Ant Design Vue 4.x 组件库
|
|
|
+- 🌍 支持国际化多语言
|
|
|
+- 📊 集成 ECharts 图表
|
|
|
+- 🔧 完善的开发工具链和代码规范
|
|
|
+- 🔐 内置权限管理和用户认证
|
|
|
+- 📝 支持富文本编辑和 Markdown
|
|
|
+
|
|
|
+## 快速开始
|
|
|
+
|
|
|
+```bash
|
|
|
+# 安装依赖
|
|
|
+pnpm install
|
|
|
+
|
|
|
+# 启动开发服务器
|
|
|
+pnpm dev
|
|
|
+
|
|
|
+# 构建生产版本
|
|
|
+pnpm build
|
|
|
+
|
|
|
+# 代码检查
|
|
|
+pnpm lint
|
|
|
+```
|
|
|
+
|
|
|
+## 项目结构
|
|
|
+
|
|
|
+```
|
|
|
+├── apps/ # 子应用目录
|
|
|
+├── internal/ # 内部工具和配置
|
|
|
+├── packages/ # 公共包
|
|
|
+├── src/ # 主应用源码
|
|
|
+├── mock/ # 模拟数据
|
|
|
+├── public/ # 静态资源
|
|
|
+└── types/ # 类型定义
|
|
|
+```
|
|
|
+
|
|
|
+## 开发指南
|
|
|
+
|
|
|
+### 环境要求
|
|
|
+
|
|
|
+- Node.js >= 18.12.0
|
|
|
+- pnpm >= 8.10.0
|
|
|
+
|
|
|
+### 开发规范
|
|
|
+
|
|
|
+- 遵循 Vue 3 组合式 API 风格
|
|
|
+- 使用 TypeScript 编写代码
|
|
|
+- 遵循 ESLint 和 Prettier 配置的代码风格
|
|
|
+- 使用 Commitizen 规范 Git 提交信息
|
|
|
+
|
|
|
+### 分支管理
|
|
|
+
|
|
|
+- main: 主分支，用于发布
|
|
|
+- develop: 开发分支
|
|
|
+- feature/*: 功能分支
|
|
|
+- hotfix/*: 紧急修复分支
|
|
|
+
|
|
|
+## API 配置
|
|
|
+
|
|
|
+项目支持多个 API 代理配置：
|
|
|
+
|
|
|
+- /api: 微信相关 API
|
|
|
+- /sys-api: 系统核心 API
|
|
|
+- /fms-api: 文件管理 API
|
|
|
+- /mms-api: 内容管理 API
|
|
|
+- /wechat-api: 微信服务 API
|
|
|
+
|
|
|
+## 许可证
|
|
|
+
|
|
|
+[MIT License](LICENSE)
|
