diff --git a/README.md b/README.md index ab94ab3..8b0ed15 100644 --- a/README.md +++ b/README.md @@ -1,148 +1,280 @@ -
](http://godban.github.io/browsers-support-badges/)IE | [
](http://godban.github.io/browsers-support-badges/)Edge | [
](http://godban.github.io/browsers-support-badges/)Firefox | [
](http://godban.github.io/browsers-support-badges/)Chrome | [
](http://godban.github.io/browsers-support-badges/)Safari |
-| :-: | :-: | :-: | :-: | :-: |
-| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
+### 5. 预览生产构建
-## Donate
+```bash
+pnpm run serve:pro
+```
-If you find this project helpful, welcome sponsorship to show your support~
+## 可用的脚本命令
-[Paypal Me](https://www.paypal.com/paypalme/ckl94)
+```bash
+# 开发
+pnpm run dev # 启动开发服务器
+
+# 构建
+pnpm run build:pro # 生产环境构建
+pnpm run build:dev # 开发环境构建
+pnpm run build:test # 测试环境构建
+pnpm run build:gitee # Gitee 构建
+
+# 预览
+pnpm run serve:pro # 预览生产构建
+pnpm run serve:dev # 预览开发构建
+pnpm run serve:test # 预览测试构建
+
+# 代码检查和格式化
+pnpm run lint:eslint # ESLint 检查和修复
+pnpm run lint:format # Prettier 代码格式化
+pnpm run lint:style # Stylelint 样式检查
+pnpm run ts:check # TypeScript 类型检查
+
+# 其他
+pnpm run icon # 生成图标文件
+pnpm run clean # 清除 node_modules
+pnpm run clean:cache # 清除缓存
+```
-
+## API 文档
+
+本项目已完全对接后端 API,主要包括以下端点:
+
+### 学生管理 API
+- `GET /api/student/list` - 获取学生列表
+- `GET /api/student/:id` - 获取学生详情
+- `POST /api/student/create` - 创建学生
+- `PUT /api/student/update` - 更新学生信息
+- `DELETE /api/student/:id` - 删除学生
+- `POST /api/student/enable` - 启用学生
+- `POST /api/student/disable` - 禁用学生
+- `POST /api/student/import` - 导入学生数据
+
+### 班级管理 API
+- `GET /api/class/list` - 获取班级列表
+- `GET /api/class/:id` - 获取班级详情
+- `POST /api/class/create` - 创建班级
+- `PUT /api/class/update` - 更新班级信息
+- `DELETE /api/class/:id` - 删除班级
+- `POST /api/class/enable` - 启用班级
+- `POST /api/class/disable` - 禁用班级
+- `POST /api/class/import` - 导入班级数据
+
+### 教师管理 API
+- `GET /api/teacher/list` - 获取教师列表
+- `GET /api/teacher/:id` - 获取教师详情
+- `POST /api/teacher/create` - 创建教师
+- `PUT /api/teacher/update` - 更新教师信息
+- `DELETE /api/teacher/:id` - 删除教师
+- `POST /api/teacher/enable` - 启用教师
+- `POST /api/teacher/disable` - 禁用教师
+- `POST /api/teacher/import` - 导入教师数据
+
+### 专业管理 API
+- `GET /api/major/list` - 获取专业列表
+- `GET /api/major/:id` - 获取专业详情
+- `POST /api/major/create` - 创建专业
+- `PUT /api/major/update` - 更新专业信息
+- `DELETE /api/major/:id` - 删除专业
+
+## 浏览器支持
+
+本项目支持所有现代浏览器,不支持 IE 浏览器。
+
+| 浏览器 | 版本要求 |
+| :-: | :-: |
+| Chrome | 最新 2 个版本 |
+| Firefox | 最新 2 个版本 |
+| Safari | 最新 2 个版本 |
+| Edge | 最新 2 个版本 |
+
+## 贡献指南
+
+我们欢迎所有的贡献!请按照以下步骤进行:
+
+1. Fork 项目
+2. 创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交您的更改 (`git commit -m 'feat: Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 打开一个 Pull Request
+
+### Git 提交规范
+
+遵循以下提交信息规范:
+
+- `feat` - 新功能
+- `fix` - 修复 bug
+- `docs` - 文档更新
+- `style` - 代码格式调整(不影响功能)
+- `refactor` - 代码重构
+- `perf` - 性能优化
+- `test` - 添加测试
+- `build` - 构建或依赖变更
+- `ci` - CI/CD 配置变更
+- `chore` - 其他杂项变更
+- `revert` - 回滚提交
+
+## 常见问题
+
+### Q: 项目如何配置后端 API 地址?
+A: 修改 `src/api` 目录下的环境配置文件,或者在 `.env` 文件中配置 `VITE_API_BASE_URL`。
+
+### Q: 如何自定义主题色?
+A: 通过 Element Plus 的主题配置系统进行自定义,详见项目的主题配置文件。
+
+### Q: 支持哪些数据导入格式?
+A: 目前支持 Excel 文件(.xlsx, .xls)的导入功能。
+
+## 项目成员
+
+- **开发者**:yuxingshi
+- **框架基础**:[vue-element-plus-admin](https://github.com/kailong321200875/vue-element-plus-admin)
+
+## 更新日志
-### My QR code
+[CHANGELOG](./CHANGELOG.md)
-If you have any project cooperation or outsourcing, please scan the code to add me as a friend and leave a note of your purpose.
+## 许可证
-
+[MIT](./LICENSE)
-## License
+---
-[MIT](./LICENSE)
+**如有任何问题或建议,欢迎提出 Issue 或 Pull Request!**