admin
e67763fa82
- Add docs/installation.md covering prerequisites, port usage, Docker startup, local development setup, default accounts, first-run validation, and common setup issues. - Link the installation guide from the project README and docs index. - Point deployment documentation to the installation guide for first-time setup. - Update AGENTS.md and progress documentation to include the new installation guide.
2.6 KiB
2.6 KiB
项目文档入口
本文档目录基于当前仓库源码整理，目标是帮助新接手者快速理解系统边界、核心流程和后续维护重点。本文档只描述已经在代码中能看到的事实；规划项会明确标为待办。
文档结构
- 安装与初始设置：从源码到可登录系统的首次安装、端口、数据库初始化和常见问题。
- 需求文档：业务目标、用户角色、功能需求和非功能约束。
- 设计文档：前端架构、路由、状态、数据模型和关键设计取舍。
- 权限设计：已确定的角色、部门、报告、模板和 AI 上下文权限规则。
- 进度文档：当前完成度、已知风险和下一步建议。
- 功能盘点：逐项区分真实可用、外部真实集成、前端演示和预留功能。
- 测试文档：测试命令、覆盖范围和待补端到端测试。
- API 契约草案：后端化前的接口语义、权限过滤和响应格式约定。
- 后端化与用户化改造方案：前后端拆分、数据模型、API、权限、安全和迁移阶段。
- 数据与存储：
localStorage/sessionStorage键、数据生命周期和迁移点。 - 部署运行：本地开发、后端 API、构建、Docker Compose 和 Nginx 部署方式。
- 安全说明：当前安全边界、敏感信息风险和生产化建议。
模块文档
快速事实
- 技术栈：React 19、TypeScript、Vite 6、Tailwind CSS 4、React Router DOM 7、NestJS、Prisma、PostgreSQL。
- 应用类型：前端 SPA + NestJS API。登录、报告、模板、用户管理、部门模板授权、系统设置和签名文件已接入后端，其余主业务页面仍处于迁移期。
- 数据层：认证用户、报告、报告媒体关系、模板、字段库、模板图片资源、视频/关键帧文件、用户管理、部门模板授权、系统设置和签名文件来自 PostgreSQL/后端文件目录。
- 本地开发端口：前端
3001，后端 API3100；Docker Compose 暴露 API 到宿主机3002。 - 默认账号：
admin / 123456、manager / 123456、0001 / 123456。 - 核心代码目录：
src/pages、src/components、src/utils、src/types.ts。