|
@@ -0,0 +1,86 @@
|
|
|
|
|
+# shadcn全栈管理后台启动模板 Fullstack Architecture Document
|
|
|
|
|
+
|
|
|
|
|
+## Table of Contents
|
|
|
|
|
+
|
|
|
|
|
+- [shadcn全栈管理后台启动模板 Fullstack Architecture Document](#table-of-contents)
|
|
|
|
|
+ - [1. Introduction](./1-introduction.md)
|
|
|
|
|
+ - [2. High Level Architecture](./2-high-level-architecture.md)
|
|
|
|
|
+ - [2.1 Technical Summary](./2-high-level-architecture.md#21-technical-summary)
|
|
|
|
|
+ - [2.2 Platform and Infrastructure Choice](./2-high-level-architecture.md#22-platform-and-infrastructure-choice)
|
|
|
|
|
+ - [2.3 Repository Structure](./2-high-level-architecture.md#23-repository-structure)
|
|
|
|
|
+ - [2.4 High Level Architecture Diagram](./2-high-level-architecture.md#24-high-level-architecture-diagram)
|
|
|
|
|
+ - [2.5 Architectural Patterns](./2-high-level-architecture.md#25-architectural-patterns)
|
|
|
|
|
+ - [3. Tech Stack](./3-tech-stack.md)
|
|
|
|
|
+ - [Technology Stack Table](./3-tech-stack.md#technology-stack-table)
|
|
|
|
|
+ - [4. Data Models](./4-data-models.md)
|
|
|
|
|
+ - [4.1 User(用户模型)](./4-data-models.md#41-user用户模型)
|
|
|
|
|
+ - [4.2 Role(角色模型)](./4-data-models.md#42-role角色模型)
|
|
|
|
|
+ - [会话管理策略](./4-data-models.md#会话管理策略)
|
|
|
|
|
+ - [5. API Specification](./5-api-specification.md)
|
|
|
|
|
+ - [OpenAPI 3.0规范(修订)](./5-api-specification.md#openapi-30规范修订)
|
|
|
|
|
+ - [基于hono/client的RPC方式](./5-api-specification.md#基于honoclient的rpc方式)
|
|
|
|
|
+ - [Zod Schema独立配置](./5-api-specification.md#zod-schema独立配置)
|
|
|
|
|
+ - [6. Components](./6-components.md)
|
|
|
|
|
+ - [6.1 认证服务 (AuthService)](./6-components.md#61-认证服务-authservice)
|
|
|
|
|
+ - [6.2 用户服务 (UserService)](./6-components.md#62-用户服务-userservice)
|
|
|
|
|
+ - [6.3 通用CRUD服务 (GenericCRUDService)](./6-components.md#63-通用crud服务-genericcrudservice)
|
|
|
|
|
+ - [6.4 通用CRUD路由 (GenericCRUDRouter)](./6-components.md#64-通用crud路由-genericcrudrouter)
|
|
|
|
|
+ - [6.5 组件关系图](./6-components.md#65-组件关系图)
|
|
|
|
|
+ - [7. Core Workflows](./7-core-workflows.md)
|
|
|
|
|
+ - [7.1 用户登录工作流](./7-core-workflows.md#71-用户登录工作流)
|
|
|
|
|
+ - [7.2 用户注册工作流](./7-core-workflows.md#72-用户注册工作流)
|
|
|
|
|
+ - [8. Database Schema](./8-database-schema.md)
|
|
|
|
|
+ - [8.1 MySQL数据库Schema](./8-database-schema.md#81-mysql数据库schema)
|
|
|
|
|
+ - [8.2 TypeORM实体定义](./8-database-schema.md#82-typeorm实体定义)
|
|
|
|
|
+ - [9. Frontend Architecture](./9-frontend-architecture.md)
|
|
|
|
|
+ - [9.1 组件架构](./9-frontend-architecture.md#91-组件架构)
|
|
|
|
|
+ - [组件组织](./9-frontend-architecture.md#组件组织)
|
|
|
|
|
+ - [组件模板](./9-frontend-architecture.md#组件模板)
|
|
|
|
|
+ - [9.2 状态管理架构](./9-frontend-architecture.md#92-状态管理架构)
|
|
|
|
|
+ - [状态结构](./9-frontend-architecture.md#状态结构)
|
|
|
|
|
+ - [9.3 路由架构](./9-frontend-architecture.md#93-路由架构)
|
|
|
|
|
+ - [路由组织](./9-frontend-architecture.md#路由组织)
|
|
|
|
|
+ - [保护路由模式](./9-frontend-architecture.md#保护路由模式)
|
|
|
|
|
+ - [9.4 前端服务层](./9-frontend-architecture.md#94-前端服务层)
|
|
|
|
|
+ - [API客户端设置](./9-frontend-architecture.md#api客户端设置)
|
|
|
|
|
+ - [10. Backend Architecture](./10-backend-architecture.md)
|
|
|
|
|
+ - [10.1 服务架构](./10-backend-architecture.md#101-服务架构)
|
|
|
|
|
+ - [控制器/路由组织](./10-backend-architecture.md#控制器路由组织)
|
|
|
|
|
+ - [控制器模板](./10-backend-architecture.md#控制器模板)
|
|
|
|
|
+ - [10.2 数据库架构](./10-backend-architecture.md#102-数据库架构)
|
|
|
|
|
+ - [Schema设计](./10-backend-architecture.md#schema设计)
|
|
|
|
|
+ - [数据访问层](./10-backend-architecture.md#数据访问层)
|
|
|
|
|
+ - [10.3 认证架构](./10-backend-architecture.md#103-认证架构)
|
|
|
|
|
+ - [认证流程](./10-backend-architecture.md#认证流程)
|
|
|
|
|
+ - [中间件/守卫](./10-backend-architecture.md#中间件守卫)
|
|
|
|
|
+ - [11. Unified Project Structure](./11-unified-project-structure.md)
|
|
|
|
|
+ - [项目目录结构](./11-unified-project-structure.md#项目目录结构)
|
|
|
|
|
+ - [Monorepo配置 (turbo.json)](./11-unified-project-structure.md#monorepo配置-turbojson)
|
|
|
|
|
+ - [根package.json脚本](./11-unified-project-structure.md#根packagejson脚本)
|
|
|
|
|
+ - [12. Development Workflow](./12-development-workflow.md)
|
|
|
|
|
+ - [12.1 Local Development Setup](./12-development-workflow.md#121-local-development-setup)
|
|
|
|
|
+ - [Prerequisites](./12-development-workflow.md#prerequisites)
|
|
|
|
|
+ - [Initial Setup](./12-development-workflow.md#initial-setup)
|
|
|
|
|
+ - [Development Commands](./12-development-workflow.md#development-commands)
|
|
|
|
|
+ - [12.2 Environment Configuration](./12-development-workflow.md#122-environment-configuration)
|
|
|
|
|
+ - [Required Environment Variables](./12-development-workflow.md#required-environment-variables)
|
|
|
|
|
+ - [开发环境快速启动脚本](./12-development-workflow.md#开发环境快速启动脚本)
|
|
|
|
|
+ - [13. Deployment Architecture](./13-deployment-architecture.md)
|
|
|
|
|
+ - [13.1 部署策略](./13-deployment-architecture.md#131-部署策略)
|
|
|
|
|
+ - [13.2 CI/CD流水线](./13-deployment-architecture.md#132-cicd流水线)
|
|
|
|
|
+ - [13.3 环境配置](./13-deployment-architecture.md#133-环境配置)
|
|
|
|
|
+ - [14. Security and Performance](./14-security-and-performance.md)
|
|
|
|
|
+ - [14.1 安全要求](./14-security-and-performance.md#141-安全要求)
|
|
|
|
|
+ - [14.2 性能优化](./14-security-and-performance.md#142-性能优化)
|
|
|
|
|
+ - [15. Testing Strategy](./15-testing-strategy.md)
|
|
|
|
|
+ - [15.1 测试金字塔](./15-testing-strategy.md#151-测试金字塔)
|
|
|
|
|
+ - [15.2 测试组织](./15-testing-strategy.md#152-测试组织)
|
|
|
|
|
+ - [16. Coding Standards](./16-coding-standards.md)
|
|
|
|
|
+ - [16.1 关键全栈规则](./16-coding-standards.md#161-关键全栈规则)
|
|
|
|
|
+ - [16.2 命名约定](./16-coding-standards.md#162-命名约定)
|
|
|
|
|
+ - [17. Error Handling Strategy](./17-error-handling-strategy.md)
|
|
|
|
|
+ - [17.1 错误流程](./17-error-handling-strategy.md#171-错误流程)
|
|
|
|
|
+ - [17.2 错误响应格式](./17-error-handling-strategy.md#172-错误响应格式)
|
|
|
|
|
+ - [18. Monitoring and Observability](./18-monitoring-and-observability.md)
|
|
|
|
|
+ - [18.1 监控栈](./18-monitoring-and-observability.md#181-监控栈)
|
|
|
|
|
+ - [18.2 关键指标](./18-monitoring-and-observability.md#182-关键指标)
|