diff --git a/README.md b/README.md index 507c75c..8f00b29 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ npm start ``` novalon-website/ -├── src/ +├── src/ # 源代码 │ ├── app/ # Next.js App Router │ │ ├── (marketing)/ # 营销页面路由组 │ │ │ ├── page.tsx # 首页 @@ -147,6 +147,7 @@ novalon-website/ │ │ ├── analytics/ # 分析组件 │ │ └── admin/ # 管理后台组件 │ ├── lib/ # 工具函数 +│ │ ├── api/ # API 服务 │ │ ├── auth/ # 认证相关 │ │ ├── db.ts # 数据库连接 │ │ ├── audit.ts # 审计日志 @@ -157,7 +158,7 @@ novalon-website/ │ │ └── migrations/ # 迁移文件 │ ├── hooks/ # 自定义 Hooks │ └── contexts/ # React Context -├── e2e/ # E2E 测试 +├── e2e/ # E2E 测试（统一测试框架） │ ├── src/ │ │ ├── tests/ # 测试用例 │ │ │ ├── smoke/ # 冒烟测试 @@ -170,14 +171,49 @@ novalon-website/ │ │ ├── pages/ # Page Object │ │ ├── fixtures/ # 测试 Fixtures │ │ └── config/ # 测试配置 -│ └── playwright.config.ts +│ ├── playwright.config.ts +│ └── MIGRATION.md # 测试框架迁移说明 +├── docs/ # 项目文档 +│ ├── architecture/ # 架构文档 +│ ├── development/ # 开发文档 +│ ├── deployment/ # 部署文档 +│ ├── testing/ # 测试文档 +│ ├── api/ # API 文档 +│ ├── guides/ # 使用指南 +│ ├── STRUCTURE_PLAN.md # 目录结构规划 +│ └── OPTIMIZATION_REPORT.md # 优化报告 +├── scripts/ # 脚本文件 +│ ├── deployment/ # 部署脚本 +│ ├── monitoring/ # 监控脚本 +│ ├── testing/ # 测试脚本 +│ ├── maintenance/ # 维护脚本 +│ └── utils/ # 工具脚本 +├── config/ # 配置文件 +│ ├── ci/ # CI/CD 配置 +│ ├── lint/ # 代码检查配置 +│ └── test/ # 测试配置 +├── reports/ # 测试报告 +│ ├── e2e/ # E2E 测试报告 +│ ├── performance/ # 性能测试报告 +│ └── coverage/ # 代码覆盖率报告 ├── public/ # 静态资源 ├── uploads/ # 上传文件存储 ├── data/ # SQLite 数据库文件 -├── docs/ # 项目文档 └── dist/ # 构建输出 ``` +### 项目优化说明 + +本项目已于 2026-03-24 完成全面的工程化与规范化优化，包括： + +1. **测试体系整合** - 统一为 Playwright TypeScript 测试框架 +2. **目录结构规范化** - 建立清晰的目录结构，符合 Next.js 最佳实践 +3. **配置文件优化** - 合并重复配置，统一配置管理 +4. **文档体系完善** - 建立完整的文档体系和导航 +5. **代码质量提升** - 修复所有类型错误，确保构建成功 + +详细信息请查看 [优化报告](docs/OPTIMIZATION_REPORT.md) + ## 页面路由 | 路由 | 描述 | @@ -220,6 +256,38 @@ novalon-website/ | `npm run db:seed` | 填充数据库种子数据 | | `npm run db:studio` | 启动 Drizzle Studio | +## 代码质量门禁 + +项目配置了自动化质量门禁，确保代码提交前通过所有质量检查： + +- **ESLint**: 代码风格检查 +- **commitlint**: 提交信息规范 +- **Jest**: 代码覆盖率检查 + +详细信息请查看 [质量门禁文档](docs/development/quality-gates.md)。 + +### 提交规范 + +使用Conventional Commits规范： + +``` +(): + + + +