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` 自动导入: ...@@ -370,6 +370,8 @@ Vant 组件通过 `unplugin-vue-components` 自动导入:
370 - 自动保存:输入内容实时缓存到 localStorage 370 - 自动保存:输入内容实时缓存到 localStorage
371 - 智能恢复:页面加载时自动填充上次未提交的内容 371 - 智能恢复:页面加载时自动填充上次未提交的内容
372 - 清理机制:提交成功或手动清除时移除草稿 372 - 清理机制:提交成功或手动清除时移除草稿
373 +- 作业有效性校验:作业失效时自动清理草稿
374 +- 完整文档:[docs/tasks/done/暂存用户打卡信息.md](./docs/tasks/done/暂存用户打卡信息.md)
373 375
374 **统一组件**: `CheckInDialog.vue` 处理所有打卡流程: 376 **统一组件**: `CheckInDialog.vue` 处理所有打卡流程:
375 377
...@@ -441,6 +443,15 @@ Vant 组件通过 `unplugin-vue-components` 自动导入: ...@@ -441,6 +443,15 @@ Vant 组件通过 `unplugin-vue-components` 自动导入:
441 443
442 ## 特殊功能 444 ## 特殊功能
443 445
446 +### 欢迎页 (2026-01 新增)
447 +
448 +- **首次访问检测**: localStorage 标志位 + 路由守卫拦截
449 +- **视频背景**: 星空宇宙主题视频(循环播放)
450 +- **功能入口**: 课程、活动、个人中心(水平布局 + 浮动动画)
451 +- **环境变量控制**: `VITE_WELCOME_PAGE_ENABLED` / `VITE_WELCOME_VIDEO_URL`
452 +- **调试工具**: `window.resetWelcomeFlag()` / `window.showWelcome()`
453 +- **完整文档**: [docs/tasks/done/26.1.28-欢迎页开发计划/](./docs/tasks/done/26.1.28-欢迎页开发计划/)
454 +
444 ### 分享海报生成 455 ### 分享海报生成
445 456
446 - 基于 Canvas 的海报生成,带二维码 (`qrcode` 包) 457 - 基于 Canvas 的海报生成,带二维码 (`qrcode` 包)
...@@ -632,12 +643,22 @@ onSubmitSuccess(() => clearDraft()) ...@@ -632,12 +643,22 @@ onSubmitSuccess(() => clearDraft())
632 643
633 ## 功能更新记录 (Recent Changes) 644 ## 功能更新记录 (Recent Changes)
634 645
635 -### 最近重要更新 646 +### 最新更新 (2026-01)
647 +
648 +**欢迎页功能** (2026-01-28):
636 649
637 -**打卡系统增强** (2025): 650 +- 新增首次访问欢迎页 (`/welcome`):星空宇宙主题视频背景
651 +- 实现首次访问检测:localStorage 标志位 + 路由守卫拦截
652 +- 水平布局功能入口:课程、活动、个人中心(带浮动动画)
653 +- 环境变量控制:`VITE_WELCOME_PAGE_ENABLED` 开关
654 +- 详细文档:[docs/tasks/done/26.1.28-欢迎页开发计划/](./docs/tasks/done/26.1.28-欢迎页开发计划/)
655 +
656 +**打卡系统增强** (2026-01):
638 657
639 - 打卡详情页重构 (`/checkin/detail`):统一文本、媒体上传和计数打卡入口 658 - 打卡详情页重构 (`/checkin/detail`):统一文本、媒体上传和计数打卡入口
640 - 新增草稿缓存功能 (`useCheckinDraft`):防止数据丢失,自动保存和恢复 659 - 新增草稿缓存功能 (`useCheckinDraft`):防止数据丢失,自动保存和恢复
660 +- 打卡卡片优化 (CheckinCard):长文本折叠、多附件 Tab 切换
661 +- 草稿恢复时的作业有效性校验:作业失效时自动清理
641 - 优化附件预览和编辑回填逻辑 662 - 优化附件预览和编辑回填逻辑
642 - 实现基于 `useCheckin` 的通用提交流程 663 - 实现基于 `useCheckin` 的通用提交流程
643 664
...@@ -812,13 +833,57 @@ onSubmitSuccess(() => clearDraft()) ...@@ -812,13 +833,57 @@ onSubmitSuccess(() => clearDraft())
812 833
813 ## 文档索引 834 ## 文档索引
814 835
815 -项目包含以下文档,帮助理解不同方面: 836 +### 📚 完整文档导航
837 +
838 +> **项目文档中心**: [docs/README.md](./docs/README.md) - 13+ 篇文档的分类索引
839 +
840 +#### 🏗️ 架构设计
841 +
842 +- [架构文档](./docs/architecture/ARCHITECTURE.md) - 应用架构、工程化配置、目录结构
843 +- [组件索引](./docs/architecture/COMPONENTS.md) - 22个组件目录的分类索引
844 +
845 +#### 💻 开发配置
846 +
847 +- [ESLint + Prettier](./docs/development/ESLINT_PRETTIER.md) - 代码规范与自动格式化配置
848 +- [Husky + lint-staged](./docs/development/HUSKY_LINT_STAGED.md) - Git Hooks 自动化检查配置
849 +- [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程与规范
850 +
851 +#### 🧪 测试文档
852 +
853 +- [Playwright 指南](./docs/testing/PLAYWRIGHT.md) - E2E 测试框架完整指南
854 +- [E2E 认证指南](./docs/testing/E2E_AUTH_GUIDE.md) - 测试登录认证流程
855 +- [E2E 代理配置](./docs/testing/E2E_PROXY_SETUP.md) - Vite 反向代理配置说明
856 +- [E2E 测试服务器](./docs/testing/E2E_TEST_SERVER.md) - 测试环境配置与服务器信息
857 +
858 +#### 🛠️ 工具指南
859 +
860 +- [Claude Skills](./docs/tools/SKILLS_GUIDE.md) - Claude Code 技能完全指南
861 +
862 +#### 📝 变更记录
863 +
864 +- [更新日志](./docs/CHANGELOG.md) - 功能更新历史(按时间倒序)
865 +
866 +#### 📋 任务管理
867 +
868 +- [已完成任务](./docs/tasks/done/) - 已完成的功能记录与总结
869 + - [暂存用户打卡信息](./docs/tasks/done/暂存用户打卡信息.md) - 草稿缓存功能
870 + - [欢迎页开发计划](./docs/tasks/done/26.1.28-欢迎页开发计划/) - 欢迎页完整实现
871 +- [开发计划](./docs/tasks/plan/) - 进行中和计划中的功能
872 +- [待办事项](./docs/tasks/todo/) - 待办功能列表
873 +- [需求收集](./docs/tasks/ideas/) - 原始需求记录
874 +
875 +### 📖 核心文档
816 876
817 - **CLAUDE.md** (本文档) - 项目总体架构与开发指南 877 - **CLAUDE.md** (本文档) - 项目总体架构与开发指南
818 - **VUE_CODE_STYLE_GUIDE.md** - Vue 代码风格规范与最佳实践 878 - **VUE_CODE_STYLE_GUIDE.md** - Vue 代码风格规范与最佳实践
819 -- **CHANGELOG.md** - 变更日志记录 879 +- **ISSUES_TO_FIX.md** - 已知问题与改进建议
880 +- **DOCUMENTATION_STANDARDS.md** - 文档编写规范
881 +
882 +### ⚙️ 配置文件
883 +
820 - **package.json** - 依赖与脚本配置 884 - **package.json** - 依赖与脚本配置
821 -- **vite.config.js** - 构建工具配置 885 +- **vite.config.js** - Vite 构建工具配置
822 -- **tailwind.config.js** - 样式系统配置 886 +- **tailwind.config.js** - TailwindCSS 样式系统配置
887 +- **.env** - 环境变量配置
823 888
824 --- 889 ---
......
...@@ -2,6 +2,32 @@ ...@@ -2,6 +2,32 @@
2 2
3 测试环境网站:<https://oa-dev.onwall.cn/f/mlaj> 3 测试环境网站:<https://oa-dev.onwall.cn/f/mlaj>
4 4
5 +## 🚀 快速开始
6 +
7 +```bash
8 +# 1. 使用 nvm 切换到正确的 Node.js 版本
9 +nvm use 18.19.1
10 +
11 +# 2. 安装依赖
12 +pnpm install
13 +
14 +# 3. 启动开发服务器
15 +pnpm dev
16 +
17 +# 4. 运行测试
18 +pnpm test
19 +
20 +# 5. 构建生产版本
21 +pnpm build
22 +```
23 +
24 +**新手上路**:
25 +
26 +- 📖 [架构文档](./docs/architecture/ARCHITECTURE.md) - 了解项目结构
27 +- 🎨 [代码风格指南](./VUE_CODE_STYLE_GUIDE.md) - Vue 代码最佳实践
28 +- 🔧 [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程
29 +-**查看完整文档**: [docs/README.md](./docs/README.md)
30 +
5 ## 项目概览 31 ## 项目概览
6 32
7 本项目是面向移动端(以微信内置浏览器为主)的教育业务 H5,覆盖「用户登录/微信授权 → 课程浏览/购买 → 学习与内容预览 → 打卡作业(学生端/教师端)→ 活动报名 → 召回促活 → 积分/订单」等完整链路。 33 本项目是面向移动端(以微信内置浏览器为主)的教育业务 H5,覆盖「用户登录/微信授权 → 课程浏览/购买 → 学习与内容预览 → 打卡作业(学生端/教师端)→ 活动报名 → 召回促活 → 积分/订单」等完整链路。
...@@ -57,39 +83,51 @@ src/ ...@@ -57,39 +83,51 @@ src/
57 - 全局屏蔽 warnHandler:[/src/main.js](file:///Users/huyirui/program/itomix/git/mlaj/src/main.js) 会吞掉 Vue 警告,可能掩盖潜在问题 83 - 全局屏蔽 warnHandler:[/src/main.js](file:///Users/huyirui/program/itomix/git/mlaj/src/main.js) 会吞掉 Vue 警告,可能掩盖潜在问题
58 - 布局目录已归一:统一使用 [/src/components/layout](file:///Users/huyirui/program/itomix/git/mlaj/src/components/layout),已移除 /src/layouts 84 - 布局目录已归一:统一使用 [/src/components/layout](file:///Users/huyirui/program/itomix/git/mlaj/src/components/layout),已移除 /src/layouts
59 85
60 -## 文档索引 86 +## 📚 完整文档导航
61 87
62 -📚 **完整文档导航**: [docs/README.md](./docs/README.md) - 所有文档的分类索引 88 +> **项目文档索引**: [docs/README.md](./docs/README.md) - 13+ 篇文档的分类索引
63 89
64 -### 快速链接 90 +### 📑 文档分类
65 91
66 -**架构设计**: 92 +#### 🏗️ 架构设计
67 93
68 -- [架构文档](./docs/architecture/ARCHITECTURE.md) - 应用架构与工程配置 94 +- [架构文档](./docs/architecture/ARCHITECTURE.md) - 应用架构、工程化配置、目录结构
69 -- [组件索引](./docs/architecture/COMPONENTS.md) - /src/components 组件目录索引 95 +- [组件索引](./docs/architecture/COMPONENTS.md) - 22个组件目录的分类索引
70 96
71 -**开发配置**: 97 +#### 💻 开发配置
72 98
73 -- [ESLint + Prettier](./docs/development/ESLINT_PRETTIER.md) - 代码规范与格式化 99 +- [ESLint + Prettier](./docs/development/ESLINT_PRETTIER.md) - 代码规范与自动格式化配置
74 -- [Husky + lint-staged](./docs/development/HUSKY_LINT_STAGED.md) - Git Hooks 配置 100 +- [Husky + lint-staged](./docs/development/HUSKY_LINT_STAGED.md) - Git Hooks 自动化检查配置
75 -- [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程 101 +- [开发工作流](./docs/development/WORKFLOW.md) - 团队开发流程与规范
76 102
77 -**测试文档**: 103 +#### 🧪 测试文档
78 104
79 -- [Playwright 指南](./docs/testing/PLAYWRIGHT.md) - E2E 测试框架 105 +- [Playwright 指南](./docs/testing/PLAYWRIGHT.md) - E2E 测试框架完整指南
80 -- [E2E 认证指南](./docs/testing/E2E_AUTH_GUIDE.md) - 测试登录认证 106 +- [E2E 认证指南](./docs/testing/E2E_AUTH_GUIDE.md) - 测试登录认证流程
81 -- [E2E 代理配置](./docs/testing/E2E_PROXY_SETUP.md) - 测试服务器代理 107 +- [E2E 代理配置](./docs/testing/E2E_PROXY_SETUP.md) - Vite 反向代理配置说明
108 +- [E2E 测试服务器](./docs/testing/E2E_TEST_SERVER.md) - 测试环境配置与服务器信息
82 109
83 -**工具指南**: 110 +#### 🛠️ 工具指南
84 111
85 - [Claude Skills](./docs/tools/SKILLS_GUIDE.md) - Claude Code 技能完全指南 112 - [Claude Skills](./docs/tools/SKILLS_GUIDE.md) - Claude Code 技能完全指南
86 113
87 -**其他**: 114 +#### 📝 变更记录
115 +
116 +- [更新日志](./docs/CHANGELOG.md) - 功能更新历史(按时间倒序)
117 +
118 +#### 📋 任务管理
119 +
120 +- [已完成任务](./docs/tasks/done/) - 已完成的功能记录
121 +- [开发计划](./docs/tasks/plan/) - 进行中和计划中的功能
122 +- [待办事项](./docs/tasks/todo/) - 待办功能列表
123 +- [需求收集](./docs/tasks/ideas/) - 原始需求记录
124 +
125 +#### 📖 其他文档
88 126
89 -- [更新日志](./docs/CHANGELOG.md) - 功能更新记录
90 - [代码风格指南](./VUE_CODE_STYLE_GUIDE.md) - Vue 代码最佳实践 127 - [代码风格指南](./VUE_CODE_STYLE_GUIDE.md) - Vue 代码最佳实践
91 - [已知问题与改进建议](./ISSUES_TO_FIX.md) - 待优化项列表 128 - [已知问题与改进建议](./ISSUES_TO_FIX.md) - 待优化项列表
92 - [项目协作说明](./CLAUDE.md) - Claude Code 开发指南(详细) 129 - [项目协作说明](./CLAUDE.md) - Claude Code 开发指南(详细)
130 +- [文档编写规范](./docs/DOCUMENTATION_STANDARDS.md) - 文档结构与格式规范
93 131
94 ## 业务系统架构 132 ## 业务系统架构
95 133
...@@ -154,9 +192,31 @@ src/ ...@@ -154,9 +192,31 @@ src/
154 192
155 实现细节(登录态注入、401 策略、微信授权、上传/预览、Vite 代理与环境变量等)已迁移到:[/docs/ARCHITECTURE.md](file:///Users/huyirui/program/itomix/git/mlaj/docs/ARCHITECTURE.md) 193 实现细节(登录态注入、401 策略、微信授权、上传/预览、Vite 代理与环境变量等)已迁移到:[/docs/ARCHITECTURE.md](file:///Users/huyirui/program/itomix/git/mlaj/docs/ARCHITECTURE.md)
156 194
157 -## 功能更新记录 (Recent Changes) 195 +## 🎉 功能更新记录
196 +
197 +### 最新更新 (2026-01)
198 +
199 +**欢迎页功能** ✨ (2026-01-28):
200 +
201 +- 首次访问欢迎页 (`/welcome`):星空宇宙主题视频背景
202 +- 首次访问检测:localStorage 标志位 + 路由守卫拦截
203 +- 水平布局功能入口:课程、活动、个人中心(带浮动动画)
204 +- 环境变量控制:`VITE_WELCOME_PAGE_ENABLED` 开关
205 +- 详细文档:[docs/tasks/done/26.1.28-欢迎页开发计划/](./docs/tasks/done/26.1.28-欢迎页开发计划/)
206 +
207 +**打卡系统增强** 📝 (2026-01):
208 +
209 +- 打卡详情页重构 (`/checkin/detail`):统一文本、媒体上传和计数打卡入口
210 +- 新增草稿缓存功能 (`useCheckinDraft`):防止数据丢失,自动保存和恢复
211 +- 打卡卡片优化 (CheckinCard):长文本折叠、多附件 Tab 切换
212 +- 草稿恢复时的作业有效性校验:作业失效时自动清理
213 +- 优化附件预览和编辑回填逻辑
214 +- 实现基于 `useCheckin` 的通用提交流程
215 +- 完整文档:[docs/tasks/done/暂存用户打卡信息.md](./docs/tasks/done/暂存用户打卡信息.md)
216 +
217 +**历史功能更新**:
158 218
159 -详细记录已迁移到:[/docs/CHANGELOG.md](file:///Users/huyirui/program/itomix/git/mlaj/docs/CHANGELOG.md) 219 +详细记录已迁移到:[/docs/CHANGELOG.md](./docs/CHANGELOG.md)
160 220
161 ## /src/components 目录下组件 221 ## /src/components 目录下组件
162 222
......