张翔
498bb3a3c8
- Move CI/CD configs to config/ci/ directory - Reorganize scripts into categorized directories (deployment, monitoring, testing, utils) - Consolidate documentation into docs/ directory with proper structure - Update linting and testing configurations - Remove obsolete test reports and performance summaries - Add new documentation for code quality tools and contact form security - Improve project organization and maintainability - Fix lint-staged config to only lint JS/TS files - Disable react/react-in-jsx-scope rule for Next.js compatibility - Ignore scripts and test config directories in ESLint
94 lines
3.0 KiB
Markdown
94 lines
3.0 KiB
Markdown
# Novalon Website 文档
|
|
|
|
欢迎来到Novalon Website项目文档中心。这里包含了项目的所有技术文档、开发指南和部署说明。
|
|
|
|
## 文档导航
|
|
|
|
### 📚 架构文档
|
|
- [系统设计](architecture/system-design.md) - 系统整体架构设计
|
|
- [数据库架构](architecture/database-schema.md) - 数据库表结构和关系
|
|
- [API架构](architecture/api-architecture.md) - API设计规范和接口说明
|
|
|
|
### 💻 开发文档
|
|
- [快速开始](development/getting-started.md) - 项目快速开始指南
|
|
- [编码规范](development/coding-standards.md) - 代码编写规范和最佳实践
|
|
- [组件开发指南](development/component-guide.md) - React组件开发指南
|
|
- [调试指南](development/debugging-guide.md) - 开发调试技巧和工具
|
|
|
|
### 🚀 部署文档
|
|
- [生产环境部署](deployment/production.md) - 生产环境部署流程
|
|
- [Docker部署](deployment/docker.md) - Docker容器化部署
|
|
- [监控配置](deployment/monitoring.md) - 系统监控和告警配置
|
|
|
|
### 🧪 测试文档
|
|
- [测试策略](testing/testing-strategy.md) - 测试策略和分层测试
|
|
- [E2E测试](testing/e2e-testing.md) - 端到端测试指南
|
|
- [单元测试](testing/unit-testing.md) - 单元测试编写指南
|
|
- [性能测试](testing/performance-testing.md) - 性能测试和优化
|
|
|
|
### 🔌 API文档
|
|
- [REST API](api/rest-api.md) - REST API接口文档
|
|
- [管理API](api/admin-api.md) - 管理后台API文档
|
|
|
|
### 📖 使用指南
|
|
- [CMS使用指南](guides/cms-guide.md) - 内容管理系统使用指南
|
|
- [认证指南](guides/authentication.md) - 用户认证和授权
|
|
- [故障排查](guides/troubleshooting.md) - 常见问题排查和解决方案
|
|
|
|
## 项目概述
|
|
|
|
Novalon Website是四川睿新致远科技有限公司的企业官网，采用现代化的技术栈构建。
|
|
|
|
### 技术栈
|
|
- **框架**: Next.js 16 + React 19
|
|
- **语言**: TypeScript
|
|
- **样式**: Tailwind CSS
|
|
- **数据库**: SQLite + Drizzle ORM
|
|
- **认证**: NextAuth.js
|
|
- **测试**: Playwright + Jest
|
|
|
|
### 核心功能
|
|
- 企业展示和产品服务介绍
|
|
- 成功案例和新闻动态
|
|
- 在线咨询和联系表单
|
|
- CMS内容管理后台
|
|
- 响应式设计和SEO优化
|
|
|
|
## 快速链接
|
|
|
|
- [项目README](../README.md) - 项目主文档
|
|
- [测试框架整合说明](../e2e/MIGRATION.md) - 测试框架迁移说明
|
|
- [目录结构规划](STRUCTURE_PLAN.md) - 项目目录结构说明
|
|
- [优化报告](OPTIMIZATION_REPORT.md) - 项目优化总结报告
|
|
|
|
## 贡献指南
|
|
|
|
### 文档更新
|
|
1. 确保文档内容准确、清晰
|
|
2. 使用Markdown格式编写
|
|
3. 添加必要的代码示例
|
|
4. 更新相关链接和引用
|
|
|
|
### 文档审查
|
|
- 技术准确性
|
|
- 内容完整性
|
|
- 格式规范性
|
|
- 链接有效性
|
|
|
|
## 获取帮助
|
|
|
|
如果在使用过程中遇到问题，可以：
|
|
1. 查看相关文档
|
|
2. 搜索[故障排查指南](guides/troubleshooting.md)
|
|
3. 联系开发团队
|
|
|
|
## 文档版本
|
|
|
|
- **版本**: 1.0.0
|
|
- **更新日期**: 2026-03-24
|
|
- **维护者**: 开发团队
|
|
|
|
---
|
|
|
|
© 2026 四川睿新致远科技有限公司
|