pangu-user-platform/pangu-ui/README.md

# 盘古用户认证中心 - 前端项目

> 统一用户管理系统前端
> 
> **开发团队**: pangu

---

## 📦 技术栈

- **前端框架**: Vue 3
- **UI 组件库**: Element Plus
- **构建工具**: Vite
- **状态管理**: Pinia
- **路由管理**: Vue Router 4
- **HTTP 客户端**: Axios

---

## 🚀 快速开始

### 环境要求

- Node.js: 16+
- npm: 8+

### 安装依赖

```bash
npm install
```

### 开发模式

```bash
npm run dev
```

访问地址: http://localhost:80

### 生产构建

```bash
npm run build:prod
```

构建产物在 `dist/` 目录

---

## 📁 项目结构

```
pangu-ui/
├── public/              # 静态资源
├── src/
│   ├── api/            # API 接口
│   ├── assets/         # 资源文件
│   ├── components/     # 公共组件
│   ├── layout/         # 布局组件
│   ├── router/         # 路由配置
│   ├── store/          # 状态管理
│   ├── utils/          # 工具函数
│   ├── views/          # 页面组件
│   │   ├── school/     # 学校管理
│   │   ├── member/     # 会员管理
│   │   ├── student/    # 学生管理
│   │   ├── application/ # 应用管理
│   │   └── base/       # 基础数据
│   ├── App.vue
│   └── main.js
├── .env.development     # 开发环境配置
├── .env.production      # 生产环境配置
├── vite.config.js       # Vite 配置
└── package.json
```

---

## ⚙️ 配置说明

### 环境变量

**开发环境** (`.env.development`):
```bash
VITE_APP_TITLE = '盘古用户认证中心'
VITE_APP_BASE_API = '/dev-api'
```

**生产环境** (`.env.production`):
```bash
VITE_APP_TITLE = '盘古用户认证中心'
VITE_APP_BASE_API = '/prod-api'
```

---

## 🎯 核心功能模块

| 模块 | 路由 | 说明 |
|------|------|------|
| 首页 | `/index` | 统计数据展示 |
| 学校管理 | `/school` | 学校、年级、班级管理 |
| 会员管理 | `/member` | 家长/教师用户管理 |
| 学生管理 | `/student` | 学生信息、批量导入 |
| 应用管理 | `/application` | 第三方应用接入 |
| 基础数据 | `/base/*` | 年级、班级、学科、区域 |

---

## 🔧 开发规范

### 代码规范

- 遵循 Vue 3 Composition API 规范
- 组件命名使用大驼峰 (PascalCase)
- 文件命名使用小写 + 连字符 (kebab-case)
- 注释使用中文

### 组件命名

```javascript
// ✅ 正确
components/
  ├── SchoolDialog.vue
  ├── MemberDialog.vue
  └── StudentDialog.vue

// ❌ 错误
components/
  ├── schoolDialog.vue
  ├── member-dialog.vue
  └── studentdialog.vue
```

### API 调用

```javascript
// api/school.js
import request from '@/utils/request'

export function listSchool(query) {
  return request({
    url: '/school/list',
    method: 'get',
    params: query
  })
}
```

---

## 🐛 常见问题

### 1. 端口被占用

修改 `vite.config.js`:
```javascript
server: {
  port: 8080, // 修改为其他端口
}
```

### 2. API 请求跨域

开发环境已配置代理，生产环境需在 Nginx 配置跨域。

### 3. Element Plus 按需引入

项目已配置自动导入，无需手动引入组件。

---

## 📝 更新日志

### v1.0.0 (2026-02-02)

- ✅ 完成首页统计数据展示
- ✅ 完成学校管理模块
- ✅ 完成会员管理模块
- ✅ 完成学生管理模块
- ✅ 完成应用管理模块
- ✅ 完成基础数据管理模块

---

## 👥 团队

**pangu**

---

## 📄 许可证

本项目为内部项目，未开源。

---

*最后更新: 2026-02-02*