diff --git a/README.md b/README.md index c2d71ad..2813d63 100644 --- a/README.md +++ b/README.md @@ -27,26 +27,37 @@ --- -## 技术栈 +## 技术栈版本 -### 后端 +### 前端技术栈 -- Spring Boot 2.7.x -- Spring Security + JWT -- MyBatis Plus 3.5.x -- MySQL 8.0 -- Redis 6.x +| 框架/库 | 当前版本 | 官方最新版本 | 说明 | +| ---------------- | ------- | ---------------- | ---------- | +| **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 | - | 运行环境要求 | -### 前端 +### 后端技术栈 -- Vue 3.x -- Element Plus 2.x -- Pinia -- Axios +| 框架/库 | 推荐版本 | 官方最新版本 | 说明 | +| ------------------- | ----- | ------ | ---------- | +| **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.x +| 框架 | 版本 | 说明 | +| ------------- | ----- | ------ | +| **RuoYi-Vue** | 3.8.8 | 后台管理框架 | --- @@ -59,17 +70,23 @@ pangu-user-platform/ │ ├── 02-系统设计/ # 系统设计文档 │ ├── 03-数据库设计/ # 数据库设计文档 │ ├── 04-接口文档/ # 接口设计文档 -│ ├── 05-测试文档/ # 测试相关文档 -│ └── 06-运维文档/ # 运维部署文档 -├── pangu-admin/ # 后台管理模块 -├── pangu-api/ # 移动端API模块 -├── pangu-open/ # 开放平台API模块 -├── pangu-common/ # 公共模块 -├── pangu-framework/ # 框架核心 -├── pangu-system/ # 系统模块 -├── pangu-generator/ # 代码生成器 -├── pangu-ui/ # 前端工程 -└── sql/ # 数据库脚本 +│ └── 多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 ``` --- @@ -78,31 +95,16 @@ pangu-user-platform/ ### 环境要求 -- JDK 1.8+ -- Maven 3.6+ -- MySQL 8.0+ -- Redis 6.0+ -- Node.js 16+ +| 环境 | 版本要求 | +| ------- | ------- | +| Node.js | ≥18.0.0 | +| npm | ≥9.0.0 | +| JDK | ≥17 | +| Maven | ≥3.8 | +| MySQL | ≥8.0 | +| Redis | ≥7.0 | -### 后端启动 - -```bash -# 1. 克隆项目 -git clone https://your-repo/pangu-user-platform.git - -# 2. 导入数据库 -mysql -u root -p < sql/pangu_user.sql - -# 3. 修改配置文件 -# 编辑 pangu-admin/src/main/resources/application-druid.yml -# 修改数据库连接信息 - -# 4. 启动项目 -cd pangu-admin -mvn spring-boot:run -``` - -### 前端启动 +### 前端启动（Mock模式） ```bash # 1. 进入前端目录 @@ -113,24 +115,63 @@ npm install # 3. 启动开发服务器 npm run dev + +# 4. 访问 +# http://localhost:3000 +# 默认账号：admin / admin123 ``` -### 访问地址 +### 前端构建 -- 后台管理：http://localhost:80 -- 后端接口：http://localhost:8080 -- Swagger文档：http://localhost:8080/swagger-ui.html +```bash +# 生产环境构建 +npm run build + +# 预览构建结果 +npm run preview +``` + +### 后端启动 + +```bash +# 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接口规范 | +| 文档 | 路径 | 说明 | +| ---------- | -------------------- | ------------ | +| 需求规格说明书 | docs/01-需求文档/ | 详细功能需求，用于评审 | +| 系统设计文档 | docs/02-系统设计/ | 架构设计、模块设计 | +| 数据库设计文档 | docs/03-数据库设计/ | 表结构、ER图、初始数据 | +| 接口设计文档 | docs/04-接口文档/ | API接口规范 | +| 多Agent开发指南 | docs/多Agent协同开发指南.md | 前端协同开发说明 | --- @@ -154,7 +195,7 @@ npm run dev | 分支 | 用途 | | --------- | ---------- | -| main | 主分支，生产环境代码 | +| master | 主分支，生产环境代码 | | develop | 开发分支 | | feature/* | 功能分支 | | hotfix/* | 紧急修复分支 | @@ -176,37 +217,26 @@ npm run dev --- -## 部署说明 +## 版本更新日志 -### 单机部署 +### v1.0.0 (2026-01-31) -```bash -# 1. 打包后端 -mvn clean package -DskipTests +**前端技术栈升级：** -# 2. 上传jar包到服务器 -scp pangu-admin/target/pangu-admin.jar user@server:/app/ +- Vue 3.5.24 → 3.5.26 +- Vite 7.2.4 → 7.3.1 -# 3. 启动服务 -nohup java -jar pangu-admin.jar --spring.profiles.active=prod > app.log 2>&1 & +**功能完成：** -# 4. 打包前端 -cd pangu-ui -npm run build:prod +- 完成登录、首页、学校管理等10个功能模块 +- 完成所有Mock数据和API接口定义 +- 完成多Agent协同开发指南 -# 5. 上传dist到Nginx目录 -scp -r dist/* user@server:/usr/share/nginx/html/ -``` +--- -### Docker部署（可选） +## 仓库地址 -```bash -# 构建镜像 -docker build -t pangu-user-platform:1.0 . - -# 运行容器 -docker run -d -p 8080:8080 --name pangu-api pangu-user-platform:1.0 -``` +- **Gitea**: http://47.99.144.51:3000/fangxh2013/pangu-user-platform --- diff --git a/pangu-ui/package-lock.json b/pangu-ui/package-lock.json index 48adede..15ce29a 100644 --- a/pangu-ui/package-lock.json +++ b/pangu-ui/package-lock.json @@ -1,24 +1,27 @@ { "name": "pangu-ui", - "version": "0.0.0", + "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "pangu-ui", - "version": "0.0.0", + "version": "1.0.0", "dependencies": { "@element-plus/icons-vue": "^2.3.2", "axios": "^1.13.4", "element-plus": "^2.13.2", "mockjs": "^1.1.0", "pinia": "^3.0.4", - "vue": "^3.5.24", + "vue": "^3.5.26", "vue-router": "^4.6.4" }, "devDependencies": { "@vitejs/plugin-vue": "^6.0.1", - "vite": "^7.2.4" + "vite": "^7.3.1" + }, + "engines": { + "node": ">=18.0.0" } }, "node_modules/@babel/helper-string-parser": { diff --git a/pangu-ui/package.json b/pangu-ui/package.json index f0ce0a7..28f6218 100644 --- a/pangu-ui/package.json +++ b/pangu-ui/package.json @@ -1,8 +1,10 @@ { "name": "pangu-ui", "private": true, - "version": "0.0.0", + "version": "1.0.0", "type": "module", + "description": "盘古用户平台 - 前端项目", + "author": "pangu", "scripts": { "dev": "vite", "build": "vite build", @@ -14,11 +16,14 @@ "element-plus": "^2.13.2", "mockjs": "^1.1.0", "pinia": "^3.0.4", - "vue": "^3.5.24", + "vue": "^3.5.26", "vue-router": "^4.6.4" }, "devDependencies": { "@vitejs/plugin-vue": "^6.0.1", - "vite": "^7.2.4" + "vite": "^7.3.1" + }, + "engines": { + "node": ">=18.0.0" } }