initial commit
This commit is contained in:
113
docs/architecture/index.md
Normal file
113
docs/architecture/index.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# Dofus Manager - Architecture Document
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Dofus Manager - Architecture Document](#table-of-contents)
|
||||
- [Table of Contents](./table-of-contents.md)
|
||||
- [1. Introduction](./1-introduction.md)
|
||||
- [Project Overview](./1-introduction.md#project-overview)
|
||||
- [Goals](./1-introduction.md#goals)
|
||||
- [Scope](./1-introduction.md#scope)
|
||||
- [Non-Functional Requirements](./1-introduction.md#non-functional-requirements)
|
||||
- [2. High-Level Architecture](./2-high-level-architecture.md)
|
||||
- [System Architecture Diagram](./2-high-level-architecture.md#system-architecture-diagram)
|
||||
- [Data Flow](./2-high-level-architecture.md#data-flow)
|
||||
- [Key Architectural Decisions](./2-high-level-architecture.md#key-architectural-decisions)
|
||||
- [3. Technology Stack](./3-technology-stack.md)
|
||||
- [Frontend](./3-technology-stack.md#frontend)
|
||||
- [Backend](./3-technology-stack.md#backend)
|
||||
- [Database](./3-technology-stack.md#database)
|
||||
- [DevOps](./3-technology-stack.md#devops)
|
||||
- [Development Tools](./3-technology-stack.md#development-tools)
|
||||
- [4. Data Models](./4-data-models.md)
|
||||
- [Entity Relationship Diagram](./4-data-models.md#entity-relationship-diagram)
|
||||
- [Core Entities](./4-data-models.md#core-entities)
|
||||
- [User](./4-data-models.md#user)
|
||||
- [Account](./4-data-models.md#account)
|
||||
- [Character](./4-data-models.md#character)
|
||||
- [Team](./4-data-models.md#team)
|
||||
- [Progression](./4-data-models.md#progression)
|
||||
- [CharacterProgression](./4-data-models.md#characterprogression)
|
||||
- [5. API Specification](./5-api-specification.md)
|
||||
- [Server Functions Pattern](./5-api-specification.md#server-functions-pattern)
|
||||
- [API Endpoints (Server Functions)](./5-api-specification.md#api-endpoints-server-functions)
|
||||
- [Characters](./5-api-specification.md#characters)
|
||||
- [Accounts](./5-api-specification.md#accounts)
|
||||
- [Teams](./5-api-specification.md#teams)
|
||||
- [Progressions](./5-api-specification.md#progressions)
|
||||
- [Auth](./5-api-specification.md#auth)
|
||||
- [Validation Schemas](./5-api-specification.md#validation-schemas)
|
||||
- [6. Components Architecture](./6-components-architecture.md)
|
||||
- [Component Hierarchy](./6-components-architecture.md#component-hierarchy)
|
||||
- [Component Design Principles](./6-components-architecture.md#component-design-principles)
|
||||
- [7. External APIs](./7-external-apis.md)
|
||||
- [DofusDB API Integration](./7-external-apis.md#dofusdb-api-integration)
|
||||
- [Endpoints Used](./7-external-apis.md#endpoints-used)
|
||||
- [Integration Service](./7-external-apis.md#integration-service)
|
||||
- [8. Core Workflows](./8-core-workflows.md)
|
||||
- [Character Creation Flow](./8-core-workflows.md#character-creation-flow)
|
||||
- [Progression Update Flow](./8-core-workflows.md#progression-update-flow)
|
||||
- [Bulk Operations Flow](./8-core-workflows.md#bulk-operations-flow)
|
||||
- [9. Database Schema](./9-database-schema.md)
|
||||
- [Prisma Schema](./9-database-schema.md#prisma-schema)
|
||||
- [10. Frontend Architecture](./10-frontend-architecture.md)
|
||||
- [State Management Strategy](./10-frontend-architecture.md#state-management-strategy)
|
||||
- [TanStack Query Setup](./10-frontend-architecture.md#tanstack-query-setup)
|
||||
- [Zustand Store](./10-frontend-architecture.md#zustand-store)
|
||||
- [Routing Structure](./10-frontend-architecture.md#routing-structure)
|
||||
- [11. Backend Architecture](./11-backend-architecture.md)
|
||||
- [Server Functions Organization](./11-backend-architecture.md#server-functions-organization)
|
||||
- [Server Function Example](./11-backend-architecture.md#server-function-example)
|
||||
- [Authentication Middleware](./11-backend-architecture.md#authentication-middleware)
|
||||
- [Caching Strategy](./11-backend-architecture.md#caching-strategy)
|
||||
- [12. Project Structure](./12-project-structure.md)
|
||||
- [13. Development Workflow](./13-development-workflow.md)
|
||||
- [Local Development Setup](./13-development-workflow.md#local-development-setup)
|
||||
- [Environment Variables](./13-development-workflow.md#environment-variables)
|
||||
- [Git Workflow](./13-development-workflow.md#git-workflow)
|
||||
- [Branch Naming](./13-development-workflow.md#branch-naming)
|
||||
- [Commit Convention](./13-development-workflow.md#commit-convention)
|
||||
- [14. Deployment Architecture](./14-deployment-architecture.md)
|
||||
- [Docker Configuration](./14-deployment-architecture.md#docker-configuration)
|
||||
- [Docker Compose (Production)](./14-deployment-architecture.md#docker-compose-production)
|
||||
- [GitLab CI/CD Pipeline](./14-deployment-architecture.md#gitlab-cicd-pipeline)
|
||||
- [15. Security & Performance](./15-security-performance.md)
|
||||
- [Security Measures](./15-security-performance.md#security-measures)
|
||||
- [Authentication](./15-security-performance.md#authentication)
|
||||
- [Input Validation](./15-security-performance.md#input-validation)
|
||||
- [Headers (via Traefik)](./15-security-performance.md#headers-via-traefik)
|
||||
- [Performance Optimizations](./15-security-performance.md#performance-optimizations)
|
||||
- [Database](./15-security-performance.md#database)
|
||||
- [Caching](./15-security-performance.md#caching)
|
||||
- [Frontend](./15-security-performance.md#frontend)
|
||||
- [Bundle Optimization](./15-security-performance.md#bundle-optimization)
|
||||
- [16. Testing Strategy](./16-testing-strategy.md)
|
||||
- [Testing Pyramid](./16-testing-strategy.md#testing-pyramid)
|
||||
- [Unit Tests (Vitest)](./16-testing-strategy.md#unit-tests-vitest)
|
||||
- [Integration Tests](./16-testing-strategy.md#integration-tests)
|
||||
- [E2E Tests (Playwright)](./16-testing-strategy.md#e2e-tests-playwright)
|
||||
- [17. Coding Standards](./17-coding-standards.md)
|
||||
- [Critical Fullstack Rules](./17-coding-standards.md#critical-fullstack-rules)
|
||||
- [Naming Conventions](./17-coding-standards.md#naming-conventions)
|
||||
- [File Structure Conventions](./17-coding-standards.md#file-structure-conventions)
|
||||
- [Component File Structure](./17-coding-standards.md#component-file-structure)
|
||||
- [Server Function File Structure](./17-coding-standards.md#server-function-file-structure)
|
||||
- [Code Quality Rules](./17-coding-standards.md#code-quality-rules)
|
||||
- [TypeScript](./17-coding-standards.md#typescript)
|
||||
- [React](./17-coding-standards.md#react)
|
||||
- [Prisma](./17-coding-standards.md#prisma)
|
||||
- [Import Order](./17-coding-standards.md#import-order)
|
||||
- [ESLint & Prettier Config](./17-coding-standards.md#eslint-prettier-config)
|
||||
- [.eslintrc.cjs](./17-coding-standards.md#eslintrccjs)
|
||||
- [.prettierrc](./17-coding-standards.md#prettierrc)
|
||||
- [Git Commit Standards](./17-coding-standards.md#git-commit-standards)
|
||||
- [18. Error Handling](./18-error-handling.md)
|
||||
- [Unified Error Types](./18-error-handling.md#unified-error-types)
|
||||
- [Backend Error Handler](./18-error-handling.md#backend-error-handler)
|
||||
- [Frontend Error Handler](./18-error-handling.md#frontend-error-handler)
|
||||
- [19. Monitoring & Observability](./19-monitoring-observability.md)
|
||||
- [Structured Logging (Pino)](./19-monitoring-observability.md#structured-logging-pino)
|
||||
- [Health Check Endpoint](./19-monitoring-observability.md#health-check-endpoint)
|
||||
- [Application Metrics](./19-monitoring-observability.md#application-metrics)
|
||||
- [20. Architecture Checklist](./20-architecture-checklist.md)
|
||||
- [Architecture Summary](./architecture-summary.md)
|
||||
Reference in New Issue
Block a user