hookehuyr

docs(readme, claude): 同步项目文档,完善功能记录和索引

主要更新:
- 新增快速开始指南,包含常用开发命令
- 添加欢迎页功能说明(首次访问检测、视频背景、功能入口)
- 更新打卡系统增强记录(草稿缓存、长文本折叠、多附件 Tab)
- 完善文档索引,指向 docs/ 目录下所有文档
- 新增功能更新记录(2026-01),包含欢迎页和打卡系统

相关文档:
- docs/tasks/done/26.1.28-欢迎页开发计划/
- docs/tasks/done/暂存用户打卡信息.md

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
......@@ -370,6 +370,8 @@ Vant 组件通过 `unplugin-vue-components` 自动导入:
- 自动保存:输入内容实时缓存到 localStorage
- 智能恢复:页面加载时自动填充上次未提交的内容
- 清理机制:提交成功或手动清除时移除草稿
- 作业有效性校验:作业失效时自动清理草稿
- 完整文档:[docs/tasks/done/暂存用户打卡信息.md](./docs/tasks/done/暂存用户打卡信息.md)
**统一组件**: `CheckInDialog.vue` 处理所有打卡流程:
......@@ -441,6 +443,15 @@ Vant 组件通过 `unplugin-vue-components` 自动导入:
## 特殊功能
### 欢迎页 (2026-01 新增)
- **首次访问检测**: localStorage 标志位 + 路由守卫拦截
- **视频背景**: 星空宇宙主题视频(循环播放)
- **功能入口**: 课程、活动、个人中心(水平布局 + 浮动动画)
- **环境变量控制**: `VITE_WELCOME_PAGE_ENABLED` / `VITE_WELCOME_VIDEO_URL`
- **调试工具**: `window.resetWelcomeFlag()` / `window.showWelcome()`
- **完整文档**: [docs/tasks/done/26.1.28-欢迎页开发计划/](./docs/tasks/done/26.1.28-欢迎页开发计划/)
### 分享海报生成
- 基于 Canvas 的海报生成,带二维码 (`qrcode` 包)
......@@ -632,12 +643,22 @@ onSubmitSuccess(() => clearDraft())
## 功能更新记录 (Recent Changes)
### 最近重要更新
### 最新更新 (2026-01)
**欢迎页功能** (2026-01-28):
**打卡系统增强** (2025):
- 新增首次访问欢迎页 (`/welcome`):星空宇宙主题视频背景
- 实现首次访问检测:localStorage 标志位 + 路由守卫拦截
- 水平布局功能入口:课程、活动、个人中心(带浮动动画)
- 环境变量控制:`VITE_WELCOME_PAGE_ENABLED` 开关
- 详细文档:[docs/tasks/done/26.1.28-欢迎页开发计划/](./docs/tasks/done/26.1.28-欢迎页开发计划/)
**打卡系统增强** (2026-01):
- 打卡详情页重构 (`/checkin/detail`):统一文本、媒体上传和计数打卡入口
- 新增草稿缓存功能 (`useCheckinDraft`):防止数据丢失,自动保存和恢复
- 打卡卡片优化 (CheckinCard):长文本折叠、多附件 Tab 切换
- 草稿恢复时的作业有效性校验:作业失效时自动清理
- 优化附件预览和编辑回填逻辑
- 实现基于 `useCheckin` 的通用提交流程
......@@ -812,13 +833,57 @@ onSubmitSuccess(() => clearDraft())
## 文档索引
项目包含以下文档,帮助理解不同方面:
### 📚 完整文档导航
> **项目文档中心**: [docs/README.md](./docs/README.md) - 13+ 篇文档的分类索引
#### 🏗️ 架构设计
- [架构文档](./docs/architecture/ARCHITECTURE.md) - 应用架构、工程化配置、目录结构
- [组件索引](./docs/architecture/COMPONENTS.md) - 22个组件目录的分类索引
#### 💻 开发配置
- [ESLint + Prettier](./docs/development/ESLINT_PRETTIER.md) - 代码规范与自动格式化配置
- [Husky + lint-staged](./docs/development/HUSKY_LINT_STAGED.md) - Git Hooks 自动化检查配置
- [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程与规范
#### 🧪 测试文档
- [Playwright 指南](./docs/testing/PLAYWRIGHT.md) - E2E 测试框架完整指南
- [E2E 认证指南](./docs/testing/E2E_AUTH_GUIDE.md) - 测试登录认证流程
- [E2E 代理配置](./docs/testing/E2E_PROXY_SETUP.md) - Vite 反向代理配置说明
- [E2E 测试服务器](./docs/testing/E2E_TEST_SERVER.md) - 测试环境配置与服务器信息
#### 🛠️ 工具指南
- [Claude Skills](./docs/tools/SKILLS_GUIDE.md) - Claude Code 技能完全指南
#### 📝 变更记录
- [更新日志](./docs/CHANGELOG.md) - 功能更新历史(按时间倒序)
#### 📋 任务管理
- [已完成任务](./docs/tasks/done/) - 已完成的功能记录与总结
- [暂存用户打卡信息](./docs/tasks/done/暂存用户打卡信息.md) - 草稿缓存功能
- [欢迎页开发计划](./docs/tasks/done/26.1.28-欢迎页开发计划/) - 欢迎页完整实现
- [开发计划](./docs/tasks/plan/) - 进行中和计划中的功能
- [待办事项](./docs/tasks/todo/) - 待办功能列表
- [需求收集](./docs/tasks/ideas/) - 原始需求记录
### 📖 核心文档
- **CLAUDE.md** (本文档) - 项目总体架构与开发指南
- **VUE_CODE_STYLE_GUIDE.md** - Vue 代码风格规范与最佳实践
- **CHANGELOG.md** - 变更日志记录
- **ISSUES_TO_FIX.md** - 已知问题与改进建议
- **DOCUMENTATION_STANDARDS.md** - 文档编写规范
### ⚙️ 配置文件
- **package.json** - 依赖与脚本配置
- **vite.config.js** - 构建工具配置
- **tailwind.config.js** - 样式系统配置
- **vite.config.js** - Vite 构建工具配置
- **tailwind.config.js** - TailwindCSS 样式系统配置
- **.env** - 环境变量配置
---
......
......@@ -2,6 +2,32 @@
测试环境网站:<https://oa-dev.onwall.cn/f/mlaj>
## 🚀 快速开始
```bash
# 1. 使用 nvm 切换到正确的 Node.js 版本
nvm use 18.19.1
# 2. 安装依赖
pnpm install
# 3. 启动开发服务器
pnpm dev
# 4. 运行测试
pnpm test
# 5. 构建生产版本
pnpm build
```
**新手上路**:
- 📖 [架构文档](./docs/architecture/ARCHITECTURE.md) - 了解项目结构
- 🎨 [代码风格指南](./VUE_CODE_STYLE_GUIDE.md) - Vue 代码最佳实践
- 🔧 [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程
-**查看完整文档**: [docs/README.md](./docs/README.md)
## 项目概览
本项目是面向移动端(以微信内置浏览器为主)的教育业务 H5,覆盖「用户登录/微信授权 → 课程浏览/购买 → 学习与内容预览 → 打卡作业(学生端/教师端)→ 活动报名 → 召回促活 → 积分/订单」等完整链路。
......@@ -57,39 +83,51 @@ src/
- 全局屏蔽 warnHandler:[/src/main.js](file:///Users/huyirui/program/itomix/git/mlaj/src/main.js) 会吞掉 Vue 警告,可能掩盖潜在问题
- 布局目录已归一:统一使用 [/src/components/layout](file:///Users/huyirui/program/itomix/git/mlaj/src/components/layout),已移除 /src/layouts
## 文档索引
## 📚 完整文档导航
📚 **完整文档导航**: [docs/README.md](./docs/README.md) - 所有文档的分类索引
> **项目文档索引**: [docs/README.md](./docs/README.md) - 13+ 篇文档的分类索引
### 快速链接
### 📑 文档分类
**架构设计**:
#### 🏗️ 架构设计
- [架构文档](./docs/architecture/ARCHITECTURE.md) - 应用架构与工程配置
- [组件索引](./docs/architecture/COMPONENTS.md) - /src/components 组件目录索引
- [架构文档](./docs/architecture/ARCHITECTURE.md) - 应用架构、工程化配置、目录结构
- [组件索引](./docs/architecture/COMPONENTS.md) - 22个组件目录的分类索引
**开发配置**:
#### 💻 开发配置
- [ESLint + Prettier](./docs/development/ESLINT_PRETTIER.md) - 代码规范与格式化
- [Husky + lint-staged](./docs/development/HUSKY_LINT_STAGED.md) - Git Hooks 配置
- [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程
- [ESLint + Prettier](./docs/development/ESLINT_PRETTIER.md) - 代码规范与自动格式化配置
- [Husky + lint-staged](./docs/development/HUSKY_LINT_STAGED.md) - Git Hooks 自动化检查配置
- [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程与规范
**测试文档**:
#### 🧪 测试文档
- [Playwright 指南](./docs/testing/PLAYWRIGHT.md) - E2E 测试框架
- [E2E 认证指南](./docs/testing/E2E_AUTH_GUIDE.md) - 测试登录认证
- [E2E 代理配置](./docs/testing/E2E_PROXY_SETUP.md) - 测试服务器代理
- [Playwright 指南](./docs/testing/PLAYWRIGHT.md) - E2E 测试框架完整指南
- [E2E 认证指南](./docs/testing/E2E_AUTH_GUIDE.md) - 测试登录认证流程
- [E2E 代理配置](./docs/testing/E2E_PROXY_SETUP.md) - Vite 反向代理配置说明
- [E2E 测试服务器](./docs/testing/E2E_TEST_SERVER.md) - 测试环境配置与服务器信息
**工具指南**:
#### 🛠️ 工具指南
- [Claude Skills](./docs/tools/SKILLS_GUIDE.md) - Claude Code 技能完全指南
**其他**:
#### 📝 变更记录
- [更新日志](./docs/CHANGELOG.md) - 功能更新历史(按时间倒序)
#### 📋 任务管理
- [已完成任务](./docs/tasks/done/) - 已完成的功能记录
- [开发计划](./docs/tasks/plan/) - 进行中和计划中的功能
- [待办事项](./docs/tasks/todo/) - 待办功能列表
- [需求收集](./docs/tasks/ideas/) - 原始需求记录
#### 📖 其他文档
- [更新日志](./docs/CHANGELOG.md) - 功能更新记录
- [代码风格指南](./VUE_CODE_STYLE_GUIDE.md) - Vue 代码最佳实践
- [已知问题与改进建议](./ISSUES_TO_FIX.md) - 待优化项列表
- [项目协作说明](./CLAUDE.md) - Claude Code 开发指南(详细)
- [文档编写规范](./docs/DOCUMENTATION_STANDARDS.md) - 文档结构与格式规范
## 业务系统架构
......@@ -154,9 +192,31 @@ src/
实现细节(登录态注入、401 策略、微信授权、上传/预览、Vite 代理与环境变量等)已迁移到:[/docs/ARCHITECTURE.md](file:///Users/huyirui/program/itomix/git/mlaj/docs/ARCHITECTURE.md)
## 功能更新记录 (Recent Changes)
## 🎉 功能更新记录
### 最新更新 (2026-01)
**欢迎页功能** ✨ (2026-01-28):
- 首次访问欢迎页 (`/welcome`):星空宇宙主题视频背景
- 首次访问检测:localStorage 标志位 + 路由守卫拦截
- 水平布局功能入口:课程、活动、个人中心(带浮动动画)
- 环境变量控制:`VITE_WELCOME_PAGE_ENABLED` 开关
- 详细文档:[docs/tasks/done/26.1.28-欢迎页开发计划/](./docs/tasks/done/26.1.28-欢迎页开发计划/)
**打卡系统增强** 📝 (2026-01):
- 打卡详情页重构 (`/checkin/detail`):统一文本、媒体上传和计数打卡入口
- 新增草稿缓存功能 (`useCheckinDraft`):防止数据丢失,自动保存和恢复
- 打卡卡片优化 (CheckinCard):长文本折叠、多附件 Tab 切换
- 草稿恢复时的作业有效性校验:作业失效时自动清理
- 优化附件预览和编辑回填逻辑
- 实现基于 `useCheckin` 的通用提交流程
- 完整文档:[docs/tasks/done/暂存用户打卡信息.md](./docs/tasks/done/暂存用户打卡信息.md)
**历史功能更新**:
详细记录已迁移到:[/docs/CHANGELOG.md](file:///Users/huyirui/program/itomix/git/mlaj/docs/CHANGELOG.md)
详细记录已迁移到:[/docs/CHANGELOG.md](./docs/CHANGELOG.md)
## /src/components 目录下组件
......