kindergarten_java/docs/README.md
2026-02-28 16:41:39 +08:00

186 lines
4.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 幼儿阅读教学服务平台
> 面向幼儿园的B2B2C阅读教学服务平台将优质绘本资源包装成教学课程帮助幼儿园老师更好地完成教学工作。
---
## 项目状态
**当前版本**: MVP开发中
**最后更新**: 2026-02-21
### 开发进度
| 阶段 | 状态 | 说明 |
|-----|------|------|
| Phase 1 - 基础框架 | ✅ 完成 | 项目架构、认证、权限 |
| Phase 2 - 超管端核心 | ✅ 完成 | 课程包制作、审核、发布 |
| Phase 3 - 教师端核心 | ✅ 完成 | 课程中心、备课、上课 |
| Phase 4 - 学校端 | ✅ 完成 | 教师/学生/班级管理 |
| Phase 5 - 家长端 | ✅ 完成 | 登录、阅读记录、成长档案 |
| Phase 6 - 功能测试 | 🔄 进行中 | 各端完整测试 |
---
## 技术架构
| 层级 | 技术 |
|-----|------|
| 前端 | Vue 3 + Vite + Ant Design Vue + Pinia |
| 后端 | NestJS + Prisma |
| 数据库 | SQLite (开发) / PostgreSQL (生产) |
| 认证 | JWT + Passport |
| 存储 | 本地文件系统 |
---
## 项目结构
```
ccProgram/
├── reading-platform-frontend/ # 前端项目
│ ├── src/
│ │ ├── api/ # API请求
│ │ ├── views/ # 页面组件
│ │ │ ├── admin/ # 超管端
│ │ │ ├── school/ # 学校端
│ │ │ ├── teacher/ # 教师端
│ │ │ ├── parent/ # 家长端
│ │ │ └── auth/ # 登录
│ │ └── ...
│ └── package.json
├── reading-platform-backend/ # 后端项目
│ ├── src/
│ │ ├── modules/ # 业务模块
│ │ │ ├── auth/ # 认证
│ │ │ ├── course/ # 课程包
│ │ │ ├── school/ # 学校端
│ │ │ ├── teacher-course/ # 教师端
│ │ │ ├── lesson/ # 授课
│ │ │ ├── task/ # 任务
│ │ │ ├── growth/ # 成长档案
│ │ │ └── resource/ # 资源库
│ │ └── ...
│ ├── prisma/
│ │ └── schema.prisma # 数据模型
│ └── uploads/ # 文件存储
├── docs/ # 项目文档
│ ├── dev-logs/ # 开发日志
│ ├── design/ # 设计文档
│ ├── README.md # 本文档
│ └── CHANGELOG.md # 变更日志
├── start-all.sh # 统一启动脚本
└── stop-all.sh # 统一停止脚本
```
---
## 快速启动
### 方式一:统一启动(推荐)
```bash
cd /Users/retirado/ccProgram
./start-all.sh
```
### 方式二:分别启动
```bash
# 后端 (端口 3000)
cd reading-platform-backend
npm run start:dev
# 前端 (端口 5173)
cd reading-platform-frontend
npm run dev
```
### 访问地址
| 服务 | 地址 |
|-----|------|
| 前端页面 | http://localhost:5173 |
| 后端API | http://localhost:3000/api/v1 |
| 静态文件 | http://localhost:3000/uploads |
---
## 测试账号
| 角色 | 账号 | 密码 |
|------|------|------|
| 超管端 | admin | admin123 |
| 学校端 | school1 | 123456 |
| 教师端 | teacher1 | 123456 |
| 家长端 | parent1 | 123456 |
| 家长端 | parent2 | 123456 |
---
## 四端功能
### 超管端
- 课程包制作工作台6步流程
- 课程包管理与审核
- 租户管理
- 资源库管理
### 学校端
- 数据概览
- 教师/学生/班级管理
- 课程使用统计
- 套餐管理
### 教师端
- 课程中心
- 备课模式
- 上课模式
- 课后反馈
- 成长档案
- 阅读任务
### 家长端
- 孩子信息查看
- 阅读记录
- 成长档案
- 亲子任务
---
## 文档索引
### 开发文档
- [CHANGELOG.md](./CHANGELOG.md) - 变更日志
- [dev-logs/](./dev-logs/) - 每日开发日志
### 设计文档
- [design/README.md](./design/README.md) - 设计文档索引
- [design/00-项目概览.md](./design/00-项目概览.md) - 项目概览
- [design/11-技术形态与MVP范围.md](./design/11-技术形态与MVP范围.md) - MVP范围
- [design/13-数据模型与API设计.md](./design/13-数据模型与API设计.md) - 数据模型
---
## 查看日志
```bash
# 后端日志
tail -f /tmp/reading-platform-backend.log
# 前端日志
tail -f /tmp/reading-platform-frontend.log
```
---
## 下一步计划
1. 完成各端功能测试
2. 修复测试中发现的问题
3. 考虑是否修复 TypeScript 编译警告
4. 根据测试结果进行优化