# 学校电子宠物

**Repository Path**: wizardWithSword/school-electronic-pets

## Basic Information

- **Project Name**: 学校电子宠物
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-01
- **Last Updated**: 2026-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 萌宠班级 🐾

基于游戏化机制的小学低段课堂行为激励系统，通过"养宠物"的方式让孩子主动养成好习惯。

---

## 项目规范（每日回顾）

### 1. 目录结构

```
gameforchild/
├── README.md               # 项目说明 + 规范（本文件）
├── docs/                   # 📄 所有文档集中存放
│   ├── PRD.md              # 产品需求文档
│   ├── PRODUCT_FRAMEWORK.md # 产品框架
│   ├── TECH_FRAMEWORK.md   # 技术框架
│   ├── SPRINT1_PRODUCT_BREAKDOWN.md # Sprint 1 拆解
│   ├── DEPLOY.md           # 部署文档
│   ├── PROJECT_LOG.md      # 项目日志
│   └── progress.md         # 📊 项目进度（唯一进度文件）
├── deploy/                 # 🚀 所有部署相关内容
│   ├── docker-compose.yml  # Docker 编排
│   ├── deploy.sh           # 部署脚本
│   └── nginx/              # Nginx 配置
├── api/                    # NestJS 后端
├── h5/                     # Next.js H5 移动端
├── pc/                     # Next.js PC 大屏端
└── landing/                # 平台介绍页
```

### 2. 文档规范

- **所有文档**必须放在 `docs/` 目录下，项目根目录不放文档文件
- 文档命名使用大写字母 + 下划线，如 `PRODUCT_FRAMEWORK.md`

### 3. 部署规范

- **所有部署相关**内容（Docker、Nginx、脚本等）必须放在 `deploy/` 目录下
- 不在项目根目录放置部署文件

### 4. 进度管理

- 项目进度**唯一文件**：`docs/progress.md`
- 每次更新项目代码或文档时，**必须同步更新** `progress.md`
- 每次确定新需求或规划时，将要做的事情加入 `progress.md`
- 所有协作者通过 `progress.md` 保持进度一致

### 5. Git 协作规范

- **改动前先拉取**：每次开始修改项目内容前，先 `git pull` 拉取最新远程代码
- **改动后及时推送**：每次需求调整、进度调整、代码调整完成后，立即 `git add` + `git commit` + `git push` 推送到远程
- **保持频繁同步**：不要积累大量改动，每完成一个小任务就推送，避免合并冲突

### 6. 协作流程

1. 开始工作前，先读 `docs/progress.md` 了解当前进度
2. 每次开始修改前，先 `git pull` 拉取最新代码
3. 完成工作后，更新 `progress.md` 中的完成状态
4. 立即提交并推送代码到远程仓库
5. 新需求先在 `progress.md` 中记录，再开始开发
6. 每天回顾一次本规范

---

## 技术栈

| 层级 | 技术 | 说明 |
|------|------|------|
| H5 移动端 | Next.js 15 + TypeScript | SSR、移动端优化 |
| PC 大屏+教师端 | Next.js 15 + TypeScript | 同一技术栈 |
| 后端 API | NestJS + TypeScript | 企业级框架 |
| 数据库 | MySQL 9.4 | 稳定可靠 |
| 缓存 | Redis 7 | 实时计算、排行榜 |
| 部署 | Docker Compose | 一键部署 |

---

## 远程仓库

```
git@gitee.com:wizardWithSword/school-electronic-pets.git
```