pangu-user-platform/.cursor/rules/pangu-project.mdc

114 lines
2.6 KiB
Plaintext
Raw Normal View History

---
description: 盘古用户平台项目规范
globs:
alwaysApply: true
---
# 盘古用户平台Pangu User Platform项目规范
## 作者规范
**重要**:本项目所有文档、代码注释的作者统一使用 **pangu**
- 文档的作者/编写团队字段:`pangu`
- 代码注释中的 @author 标签:`pangu`
- SQL 脚本中的作者注释:`pangu`
- 不使用个人姓名、英文名或其他名称
示例:
```java
/**
* 学校管理服务
* @author pangu
*/
public class SchoolService { }
```
```javascript
/**
* 学校管理API
* @author pangu
*/
```
```sql
-- 作者pangu
```
## 项目信息
- **项目名称**盘古用户平台Pangu User Platform
- **远程仓库**http://47.99.144.51:3000/fangxh2013/pangu-user-platform
- **数据库**pguser-dbcourier_test 服务器8.148.25.55
## 技术栈
### 前端ruoyi-ui
- Vue 3.5.x + Element Plus 2.13.x + Vite 6.x
- 基于 RuoYi-Vue3 框架
### 后端(待开发)
- Spring Boot 3.3.x + JDK 17+
- 基于 RuoYi-Vue 框架
## API 接口规范(若依做法)
本项目采用若依(RuoYi)框架推荐的 API 前缀规范:
### 规则说明
| 位置 | 配置 | 说明 |
|------|------|------|
| 前端 baseURL | `/dev-api` | 开发环境 API 前缀 |
| 代理重写 | `/dev-api` → `''` | 去掉前缀后转发 |
| 后端接口 | 无前缀 | `/login`, `/system/user` |
### 请求流程
```
前端请求: /dev-api/system/user/list
↓ (vite 代理去掉 /dev-api)
后端接收: /system/user/list
```
### 代码示例
```javascript
// vite.config.js
proxy: {
'/dev-api': {
target: 'http://localhost:8080',
rewrite: (p) => p.replace(/^\/dev-api/, '') // 去掉前缀
}
}
```
```java
// 后端 Controller - 不带 /api 前缀
@RestController
@RequestMapping("/system/user")
public class SysUserController { }
@RestController // LoginController 无类级别前缀
public class LoginController {
@GetMapping("/captchaImage") // 直接 /captchaImage
public AjaxResult getCaptchaImage() { }
}
```
### 注意事项
- **新建 Controller 不要添加 `/api` 前缀**
- 前端 API 调用路径如 `/system/user/list`,会被自动加上 `/dev-api` 前缀
- 生产环境通过 nginx 配置同样的代理规则
## 业务模块
| 模块 | 路径 | 说明 |
|------|------|------|
| 学校管理 | views/school/ | 管理学校、年级、班级 |
| 会员管理 | views/member/ | 管理家长/教师 |
| 学生管理 | views/student/ | 管理学生信息 |
| 应用管理 | views/application/ | 第三方应用接入 |
| 基础数据 | views/base/ | 年级/班级/学科/区域 |