# esgi-doctodoc/docto-doc-web-app architecture

> Architecture diagram of the GitHub repository esgi-doctodoc/docto-doc-web-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/esgi-doctodoc/docto-doc-web-app
- Repository: https://github.com/esgi-doctodoc/docto-doc-web-app

## Overview

##### Project Type and Purpose
- This is a Nuxt (Vue 3) front-end application.
- It delivers pages via Nuxt’s SSR/SSG or client-side hydration, uses MSW for local API mocking, and interacts with a set of REST endpoints (appointments, doctors, auth, etc.).
- Purpose: Admin/user portal for managing doctors, appointments, patients, care-tracking, messaging, subscriptions, etc.

##### File Structure
- Top-level:
- nuxt.config.ts – overall framework config (SSR, modules, plugins)
- src/ – application code
- public/ – static assets & mock worker
- Within src:
- pages/ – route definitions (Nuxt file‐based routing)
- components/ – UI building blocks (modals, inputs, tables, slideover, etc.)
- layouts/ – AuthLayout, MainLayout
- composables/ – reusable logic hooks (auth, calendar, modal, messaging)
- services/ – HTTP wrapper “API layer” organized by domain (appointments, auth, doctors, etc.)
- stores/ – state management (Pinia or Vuex – here appears Pinia)
- plugins/ – i18n and MSW integration
- mocks/ – MSW handlers for offline development
- api/ – low-level api‐client, request builder, schemas, types
- middleware/ – global auth guard, role guard
- assets & public/images – static images
- locales/ – translation files

##### README
- Confirms standard Nuxt scaffolding, npm scripts for dev, build, preview, deployment pointers.

a. Main Components
- Browser/Client (Nuxt SSR + client‐side SPA)
- Nuxt Server/SSR or CDN-delivered static site
- MSW (Mock Service Worker) for local API mocking
- API Layer (api-client.ts + request-builder)
- Domain Services (services/*: appointments.api.ts, auth.api.ts, etc.)
- External RESTful Backend APIs (Auth, Appointments, Doctors, Patients, Messaging, etc.)
- State Store (Pinia stores in src/stores)
- Composables (logic layer between components and services)
- UI Layer (Layouts, Pages, Components)
- Plugins (i18n, MSW client)
- Middleware (auth.global, role)

b. Relationships & Data Flow
1. User → Browser loads page → Nuxt SSR (if SSR) or static assets → Vue application boots
2. Client initializes plugins (i18n, MSW)
3. Page components call composables → composables call domain services
4. Domain services use api-client → issue HTTP requests (or MSW intercepts) → Backend APIs
5. Responses flow back → services parse DTOs → composables update Pinia store
6. UI components reactively render based on store state
7. Middleware guards protect routes before rendering pages

c. Architectural Patterns & Principles
- Layers: Presentation (components/pages/layouts) → Composition (composables) → Service/Repository (services) → HTTP Client (api) → External API
- Separation of Concerns: validation in src/components/inputs/validators, localization in plugins & locales, state in stores
- Modularization: Domain-based directories under services, mocks, components
- Dependency Injection via composables & plugins
- Mocking Strategy: MSW for offline development, registered as a client plugin

d. Key Technologies & Frameworks
- Nuxt 3 (SSR/SSG, file‐based routing, modules)
- Vue 3 Composition API (composables)
- Pinia (stores)
- TypeScript (types in src/types, DTOs)
- MSW (mocking layer)
- i18n (vue-i18n plugin)
- REST API (axios/fetch via request-builder)

## Diagram (Mermaid)

```mermaid
flowchart TD
  Browser["User Browser"]:::external
  CDN["Nuxt Server / CDN"]:::external
  Browser -->|"HTTP Request"| CDN
  CDN -->|"Serves SSR／Static"| Browser

  subgraph "Nuxt Application"
    direction TB
    NP["nuxt.config.ts"]:::infra
    APPSRC["src/app.vue"]:::ui
    Plugins["Plugins"]:::infra
    subgraph PluginsDetails
      I18n["i18n Plugin"]:::infra
      MSW["MSW Plugin"]:::infra
    end
    Middleware["Middleware"]:::infra
    subgraph UI["UI Layer"]
      direction TB
      Pages["Pages"]:::ui
      Layouts["Layouts"]:::ui
      Components["Components"]:::ui
      subgraph ComponentsDetails
        Modals["Modals"]:::ui
        Slideover["Slideover"]:::ui
        Inputs["Inputs & Validators"]:::ui
        Tables["Tables"]:::ui
      end
    end
    Composables["Composables"]:::logic
    Stores["Pinia Stores"]:::logic
    subgraph Services["Domain Services"]
      direction TB
      Appointments["Appointments API"]:::logic
      AuthS["Auth API"]:::logic
      Doctors["Doctors API"]:::logic
      Patients["Patients API"]:::logic
      Slots["Slots API"]:::logic
      MedConcerns["Medical Concerns API"]:::logic
      CareTracking["Care Tracking API"]:::logic
      Messages["Messages API"]:::logic
      Subscriptions["Subscriptions API"]:::logic
      Media["Media API"]:::logic
      Onboarding["Onboarding API"]:::logic
      Autocomplete["Autocomplete API"]:::logic
      Absences["Absences API"]:::logic
      Specialities["Specialities API"]:::logic
    end
    subgraph APIClientLayer["API Client Layer"]
      direction TB
      RequestBuilder["Request Builder"]:::infra
      APIClient["API Client"]:::infra
    end
    DTOs["DTO Schemas"]:::infra
  end

  Browser -->|"Boot Nuxt"| APPSRC
  APPSRC --> Plugins
  Plugins --> I18n
  Plugins --> MSW
  APPSRC --> Middleware
  Middleware -->|"Guards"| Pages
  APPSRC --> UI
  UI --> Composables
  Composables --> Stores
  Composables --> Services
  Services --> APIClient
  APIClient --> RequestBuilder
  APIClient -->|"REST／HTTP"| Backend["External Backend APIs"]:::external
  Backend -->|"Responses DTOs"| APIClient
  APIClient --> DTOs
  DTOs --> Services
  Services -->|"Parsed Data"| Composables
  Stores --> UI
  UI --> Browser
  MSW -->|"Intercept"| APIClient

  click NP "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/nuxt.config.ts"
  click APPSRC "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/app.vue"
  click Pages "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/pages/"
  click Layouts "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/layouts/"
  click Components "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/components/"
  click Modals "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/components/modals/"
  click Slideover "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/components/slideover/"
  click Inputs "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/components/inputs/"
  click Tables "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/components/table/"
  click Composables "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/composables/"
  click Stores "https://github.com/esgi-doctodoc/docto-doc-web-app/tree/develop/src/stores/"
  click APIClient "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/api/api-client.ts"
  click RequestBuilder "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/api/request-builder.ts"
  click Appointments "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/appointments/appointment.api.ts"
  click AuthS "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/auth/auth.api.ts"
  click Doctors "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/doctors/doctors.api.ts"
  click Patients "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/patients/patient.api.ts"
  click Slots "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/slots/slot.api.ts"
  click MedConcerns "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/medical-concerns/medical-concerns.api.ts"
  click CareTracking "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/care-tracking/care-tracking.api.ts"
  click Messages "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/messages/message.api.ts"
  click Subscriptions "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/subscriptions/subscription.api.ts"
  click Media "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/media/media.api.ts"
  click Onboarding "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/onboarding/onboarding.api.ts"
  click Autocomplete "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/autocompleteApi/autocomplete.api.ts"
  click Absences "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/absences/doctorAbsenceApi.ts"
  click Specialities "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/services/specialities/speciality.api.ts"
  click I18n "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/plugins/i18n.ts"
  click MSW "https://github.com/esgi-doctodoc/docto-doc-web-app/blob/develop/src/plugins/msw.client.ts"

  classDef ui fill:#ADD8E6,stroke:#000
  classDef logic fill:#90EE90,stroke:#000
  classDef infra fill:#FFA500,stroke:#000
  classDef external fill:#D3D3D3,stroke:#000
```
