通过浏览器实际检查所有页面,编写完整的前端UI规范文档: - 设计原则、色彩规范、布局规范 - 表格规范、表单规范、分页规范 - 状态Tag规范、交互规范 - Mock数据规范、文件命名规范 同时记录了各页面发现的问题: - P0: 年级/班级/学科/区域管理的Mock字段名不匹配 - P1: 应用管理授权接口列字段名不匹配 - P2: 学校管理操作列宽度不足 - P3: Mock时间数据范围过大 |
||
|---|---|---|
| .cursor/rules | ||
| docs | ||
| pangu-ui | ||
| ruoyi-ui | ||
| sql | ||
| .gitignore | ||
| README.md | ||
README.md
盘古用户平台(Pangu User Platform)
面向教育行业的统一用户管理系统
项目简介
盘古用户平台是一个基于 RuoYi-Vue 框架开发的教育行业用户管理系统,主要用于管理学校、教师、家长和学生信息,并为其他业务系统提供统一的用户认证和授权服务。
核心功能
- 学校管理:管理学校、年级、班级的树形组织结构
- 会员管理:管理前端用户(家长/教师),支持多种登录方式
- 学生管理:管理学生信息,支持批量导入
- 应用管理:管理第三方应用接入,控制API访问权限
- 基础数据:年级、班级、学科、区域等基础数据维护
- 系统设置:用户、角色、菜单、部门等系统管理(复用RuoYi)
角色权限
| 角色 | 权限范围 |
|---|---|
| 超级管理员 | 全部功能,管理所有数据 |
| 分公司用户 | 管理所属区域的学校、会员、学生 |
| 学校用户 | 管理本校的教师、学生 |
技术栈版本
前端技术栈
| 框架/库 | 当前版本 | 官方最新版本 | 说明 |
|---|---|---|---|
| Vue | 3.5.26 | 3.5.26 | ✅ 最新稳定版 |
| Vite | 7.3.1 | 7.3.1 | ✅ 最新稳定版 |
| Element Plus | 2.13.2 | 2.13.1 | ✅ 已是最新 |
| Pinia | 3.0.4 | 3.0.4 | ✅ 最新稳定版 |
| Vue Router | 4.6.4 | 4.6.4 (5.0.0刚发布) | ✅ 稳定版 |
| Axios | 1.13.4 | 1.13.4 | ✅ 最新稳定版 |
| MockJS | 1.1.0 | 1.1.0 | ✅ 用于Mock数据 |
| Node.js | ≥18.0.0 | - | 运行环境要求 |
后端技术栈
| 框架/库 | 推荐版本 | 官方最新版本 | 说明 |
|---|---|---|---|
| Spring Boot | 3.3.x | 4.0.2 | 建议使用LTS版本 |
| Spring Security | 6.x | 6.4.x | JWT认证 |
| MyBatis Plus | 3.5.x | 3.5.9 | ORM框架 |
| MySQL | 8.0+ | 8.0.40 | 数据库 |
| Redis | 7.x | 7.4.x | 缓存/Session |
| JDK | 17+ | 21 LTS | 运行环境 |
基础框架
| 框架 | 版本 | 说明 |
|---|---|---|
| RuoYi-Vue | 3.8.8 | 后台管理框架 |
项目结构
pangu-user-platform/
├── docs/ # 项目文档
│ ├── 01-需求文档/ # 需求规格说明书
│ ├── 02-系统设计/ # 系统设计文档
│ ├── 03-数据库设计/ # 数据库设计文档
│ ├── 04-接口文档/ # 接口设计文档
│ └── 多Agent协同开发指南.md # 前端多Agent开发文档
├── pangu-ui/ # 前端工程 (Vue 3)
│ ├── src/
│ │ ├── api/ # API接口定义
│ │ ├── assets/ # 静态资源
│ │ ├── components/ # 公共组件
│ │ ├── layout/ # 布局组件
│ │ ├── mock/ # Mock数据
│ │ ├── router/ # 路由配置
│ │ ├── store/ # Pinia状态管理
│ │ ├── utils/ # 工具函数
│ │ └── views/ # 页面视图
│ ├── package.json
│ └── vite.config.js
├── ruoyi-backend/ # 后端工程 (待开发)
├── ruoyi-ui/ # RuoYi原版前端 (参考)
└── README.md
快速开始
环境要求
| 环境 | 版本要求 |
|---|---|
| Node.js | ≥18.0.0 |
| npm | ≥9.0.0 |
| JDK | ≥17 |
| Maven | ≥3.8 |
| MySQL | ≥8.0 |
| Redis | ≥7.0 |
前端启动(Mock模式)
# 1. 进入前端目录
cd pangu-ui
# 2. 安装依赖
npm install
# 3. 启动开发服务器
npm run dev
# 4. 访问
# http://localhost:3000
# 默认账号:admin / admin123
前端构建
# 生产环境构建
npm run build
# 预览构建结果
npm run preview
后端启动
# 1. 导入数据库
mysql -u root -p < sql/pangu_user.sql
# 2. 修改配置文件
# 编辑 application-druid.yml,配置数据库连接
# 3. 启动项目
mvn spring-boot:run
功能模块
| 模块 | 路由 | 状态 | 说明 |
|---|---|---|---|
| 登录 | /login | ✅ 完成 | 用户名密码+验证码 |
| 首页 | /dashboard | ✅ 完成 | 统计卡片 |
| 学校管理 | /school | ✅ 完成 | 左侧区域树+右侧列表 |
| 会员管理 | /member | ✅ 完成 | 家长/教师管理 |
| 学生管理 | /student | ✅ 完成 | 左侧学校树+右侧列表 |
| 应用管理 | /application | ✅ 完成 | 第三方应用接入 |
| 年级管理 | /base/grade | ✅ 完成 | 基础数据 |
| 班级管理 | /base/class | ✅ 完成 | 基础数据 |
| 学科管理 | /base/subject | ✅ 完成 | 基础数据 |
| 区域管理 | /base/region | ✅ 完成 | 树形表格 |
文档说明
| 文档 | 路径 | 说明 |
|---|---|---|
| 需求规格说明书 | docs/01-需求文档/ | 详细功能需求,用于评审 |
| 系统设计文档 | docs/02-系统设计/ | 架构设计、模块设计 |
| 数据库设计文档 | docs/03-数据库设计/ | 表结构、ER图、初始数据 |
| 接口设计文档 | docs/04-接口文档/ | API接口规范 |
| 多Agent开发指南 | docs/多Agent协同开发指南.md | 前端协同开发说明 |
原型设计
- 墨刀原型:https://modao.cc/proto/atlwMul8t9pi6yxQ42W7up/sharing
- 页面数量:17个
- 访问方式:只读模式
原型批注要点
详细批注信息见
docs/01-需求文档/需求规格说明书_v1.0.md第8章
| 模块 | 关键批注 |
|---|---|
| 全局 | 系统支持3个角色:管理员、分公司用户、学校用户;会员需使用token支持小程序/H5登录 |
| 学校管理 | 学校下新增年级/班级为挂载模式(非新建);删除需检查子级和引用;所有删除为软删除 |
| 会员管理 | 支持3种登录方式;教师必须绑定学校信息且只能绑定本校学生;家长可绑定任意学生 |
| 学生管理 | 批量导入时自动创建不存在的家长用户(初始密码:123456) |
| 应用管理 | 重置密钥需弹窗显示并支持复制;接口授权采用勾选方式 |
| 区域管理 | 新增下级时自动带入父级区域 |
示例数据
区域示例:
湖北 → 武汉 → 武昌区/汉口区/汉阳区/江夏区/新洲区/黄陂区
湖北 → 黄冈 → 黄州区/红安县/麻城市
北京 | 香港 | 吉宁
学校示例:
- 武汉市第一中学(七年级1-3班、八年级、九年级)
- 武汉市第三中学
- 武汉市水果湖小学(一至六年级)
应用示例:
- AI智慧平台(YY000001)- 授权接口:学校接口、年级接口、班级接口
开发规范
作者规范
重要:本项目所有文档、代码注释的作者统一使用 pangu
- 文档的作者/编写团队:
pangu - 代码注释中的 @author:
pangu - 不使用个人姓名或其他名称
代码规范
- 遵循《湖北新华业务中台代码规范》
- 类/方法使用Javadoc注释
- 使用统一的返回格式和异常处理
分支管理
| 分支 | 用途 |
|---|---|
| master | 主分支,生产环境代码 |
| develop | 开发分支 |
| feature/* | 功能分支 |
| hotfix/* | 紧急修复分支 |
提交规范
<type>: <简要描述>
类型说明:
- feat: 新功能
- fix: 修复Bug
- docs: 文档修改
- style: 代码格式调整
- refactor: 代码重构
- test: 测试相关
- chore: 构建/工具变动
版本更新日志
v1.0.1 (2026-01-31)
文档完善:
- 需求规格说明书:补充墨刀原型批注汇总(第8.3章)
- 数据库设计文档:补充学校/会员/学生/应用示例数据
- 接口设计文档:补充业务规则说明(第10章)
- README.md:补充原型批注要点和示例数据
v1.0.0 (2026-01-31)
前端技术栈升级:
- Vue 3.5.24 → 3.5.26
- Vite 7.2.4 → 7.3.1
功能完成:
- 完成登录、首页、学校管理等10个功能模块
- 完成所有Mock数据和API接口定义
- 完成多Agent协同开发指南
仓库地址
联系方式
- 团队:pangu
- 创建时间:2026-01-31
最后更新:2026-01-31