张翔
125 lines
5.7 KiB
Markdown
125 lines
5.7 KiB
Markdown
# Novalon Website 文档
|
|
|
|
欢迎来到 Novalon Website 项目文档中心。这里包含了项目的所有技术文档、开发指南和部署说明。
|
|
|
|
## 📚 文档导航
|
|
|
|
### 架构文档 (architecture/)
|
|
|
|
- [系统设计](architecture/system-design.md) - 系统整体架构设计
|
|
- [架构概述](architecture/architecture.md) - 架构设计原则和模式
|
|
- [结构规划](architecture/STRUCTURE_PLAN.md) - 项目结构规划文档
|
|
|
|
### 开发文档 (development/)
|
|
|
|
- [快速开始](development/getting-started.md) - 项目快速开始指南
|
|
- [API 文档](development/api.md) - API 接口文档
|
|
- [API 版本控制指南](development/api-versioning-guide.md) - API 版本控制最佳实践
|
|
- [组件开发指南](development/components.md) - React 组件开发指南
|
|
- [OpenAPI 指南](development/openapi-guide.md) - OpenAPI 规范和使用
|
|
- [联系方式配置](development/CONTACT_CONFIGURATION.md) - 联系表单配置说明
|
|
- [实施报告](development/IMPLEMENTATION-REPORT.md) - 功能实施报告
|
|
- [质量门禁](development/quality-gates.md) - 代码质量门禁配置
|
|
|
|
### 部署文档 (deployment/)
|
|
|
|
- [部署指南](deployment/DEPLOYMENT.md) - 部署流程和步骤
|
|
- [生产环境部署](deployment/PRODUCTION_DEPLOYMENT.md) - 生产环境部署指南
|
|
- [轻量级生产部署](deployment/PRODUCTION_DEPLOYMENT_LIGHTWEIGHT.md) - 轻量级部署方案
|
|
- [生产发布报告](deployment/PRODUCTION_RELEASE_REPORT.md) - 生产发布记录
|
|
- [CDN 配置](deployment/CDN_CONFIGURATION.md) - CDN 配置指南
|
|
- [CDN 快速开始](deployment/CDN_QUICK_START.md) - CDN 快速配置
|
|
- [CI/CD 快速开始](deployment/CICD_QUICK_START.md) - CI/CD 流程快速指南
|
|
- [CI/CD 预防指南](deployment/CICD_PREVENTION_GUIDE.md) - CI/CD 问题预防
|
|
- [CI/CD 验证清单](deployment/CICD_VERIFICATION_CHECKLIST.md) - CI/CD 验证检查清单
|
|
- [质量门禁 CI](deployment/quality-gates-ci.md) - CI 质量门禁配置
|
|
- [回滚流程](deployment/rollback-procedure.md) - 部署回滚操作流程
|
|
- [阶段一部署指南](deployment/phase1-deployment-guide.md) - 第一阶段部署指南
|
|
- [阶段一部署日志](deployment/phase1-deployment-log.md) - 第一阶段部署记录
|
|
- [Google Analytics 设置](deployment/GOOGLE_ANALYTICS_SETUP.md) - Google Analytics 配置
|
|
- [监控设置](deployment/MONITORING_SETUP.md) - 系统监控配置
|
|
- [监控快速开始](deployment/MONITORING_QUICKSTART.md) - 监控快速配置
|
|
- [轻量级监控](deployment/MONITORING_LIGHTWEIGHT.md) - 轻量级监控方案
|
|
- [轻量级监控](deployment/LIGHTWEIGHT_MONITORING.md) - 监控方案说明
|
|
- [优化报告](deployment/OPTIMIZATION_REPORT.md) - 性能优化报告
|
|
- [性能优化](deployment/PERFORMANCE_OPTIMIZATION.md) - 性能优化指南
|
|
|
|
### 测试文档 (testing/)
|
|
|
|
- [测试指南](testing/testing-guide.md) - 测试编写指南
|
|
- [测试概述](testing/testing.md) - 测试策略和方法
|
|
- [分层测试](testing/README-TIERED-TESTING.md) - 分层测试策略
|
|
- [测试报告](testing/TESTING_REPORT.md) - 测试执行报告
|
|
- [Allure 报告指南](testing/allure-report-guide.md) - Allure 测试报告使用
|
|
- [Lighthouse CI 指南](testing/lighthouse-ci-guide.md) - Lighthouse CI 配置
|
|
- [测试覆盖率改进计划](testing/test-coverage-improvement-plan.md) - 测试覆盖率提升计划
|
|
- [测试优化指南](testing/test-optimization-guide.md) - 测试优化策略
|
|
- [测试分层最佳实践](testing/test-tiering-best-practices.md) - 测试分层最佳实践
|
|
- [用户旅程覆盖矩阵](testing/user-journey-coverage-matrix.md) - 用户旅程测试覆盖
|
|
- [用户旅程测试指南](testing/user-journey-testing-guide.md) - 用户旅程测试编写
|
|
|
|
### 安全文档 (security/)
|
|
|
|
- [管理员凭证](security/ADMIN-CREDENTIALS.md) - 管理员账户信息
|
|
- [Jenkins 安全加固指南](security/JENKINS_SECURITY_HARDENING_GUIDE.md) - Jenkins 安全配置
|
|
|
|
### 故障排查 (troubleshooting/)
|
|
|
|
- [HMR 错误解决方案](troubleshooting/HMR-ERROR-SOLUTIONS.md) - 热更新错误排查
|
|
- [修复计划 A 指南](troubleshooting/fix-plan-a-guide.md) - 问题修复流程
|
|
- [生产环境超时排查](troubleshooting/production-timeout-troubleshooting.md) - 生产环境超时问题排查
|
|
|
|
### 指南文档 (guides/)
|
|
|
|
- [安全指南](guides/SECURITY.md) - 安全最佳实践
|
|
|
|
### 计划文档 (plans/)
|
|
|
|
包含各种技术改进和功能开发的计划文档，按日期命名。
|
|
|
|
### Superpowers 文档 (superpowers/)
|
|
|
|
- **plans/** - 实施计划
|
|
- [项目重组计划](superpowers/plans/2026-04-12-project-reorganization-plan.md)
|
|
- **reports/** - 实施报告
|
|
- [用户旅程测试实施总结](superpowers/reports/2026-04-09-user-journey-testing-implementation-summary.md)
|
|
- **specs/** - 设计规范
|
|
- [测试质量改进设计](superpowers/specs/2026-04-09-test-quality-improvement-design.md)
|
|
- [项目重组设计](superpowers/specs/2026-04-12-project-reorganization-design.md)
|
|
|
|
## 🎯 项目概述
|
|
|
|
Novalon Website 是四川睿新致远科技有限公司的企业官网，采用现代化的技术栈构建。
|
|
|
|
### 技术栈
|
|
|
|
- **框架**: Next.js 16 + React 19
|
|
- **语言**: TypeScript
|
|
- **样式**: Tailwind CSS
|
|
- **数据库**: SQLite + Drizzle ORM
|
|
- **认证**: NextAuth.js
|
|
- **测试**: Playwright + Jest
|
|
|
|
### 核心功能
|
|
|
|
- 📝 内容管理系统 (CMS)
|
|
- 🔐 用户认证和授权
|
|
- 📊 数据分析和监控
|
|
- 🚀 高性能和 SEO 优化
|
|
- 🔄 CI/CD 自动化部署
|
|
|
|
## 📖 快速链接
|
|
|
|
- [快速开始](development/getting-started.md) - 开始开发
|
|
- [部署指南](deployment/DEPLOYMENT.md) - 部署到生产环境
|
|
- [测试指南](testing/testing-guide.md) - 编写测试
|
|
- [故障排查](troubleshooting/HMR-ERROR-SOLUTIONS.md) - 解决问题
|
|
|
|
## 🤝 贡献指南
|
|
|
|
请参阅 [开发文档](development/getting-started.md) 了解如何为项目做出贡献。
|
|
|
|
## 📄 许可证
|
|
|
|
本项目采用 MIT 许可证。
|