# nicopoore/argentina-vaccines architecture

> Architecture diagram of the GitHub repository nicopoore/argentina-vaccines, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nicopoore/argentina-vaccines
- Repository: https://github.com/nicopoore/argentina-vaccines

## Overview

##### Main Components
- Frontend/UI Layer:
- Pages: Under the src/pages directory (e.g., _app.tsx, _document.tsx, index.tsx) that integrate the overall layout.
- Components: Located in src/components and further grouped into sections (e.g., BarChartsSection, HistogramSection, NumbersSection, VaccineTypeSection). These components render charts, maps (using React Simple Maps), dose information, and modals.
- Motion & Styling: Utilizes Chakra UI for styling and Framer Motion from src/utils/MotionComponents for animations.
- Testing: Numerous tests under src/__tests__ ensure component functionality.

- API/Data Layer:
- API Endpoints: Found in src/pages/api. They include routes for fetching current data (data.ts) as well as historic data (historic_data endpoints).
- Database Connectivity: The data layer interacts with a MongoDB database through modules in src/utils/Database (actions.ts, connect.ts), suggesting a separation between request handling and database actions.

- State Management:
- Context Providers: In src/utils/Context (DataContext.tsx, SelectionContext.tsx) to manage data sharing and user selections (e.g., which province is selected).

- External Services & Libraries:
- Mapping: Use of React Simple Maps for visualizing provinces on a map.
- Charting: Recharts is used to display bar charts, histograms, and other visualizations.
- Data Parsing: Papaparse and date-fns are included, likely for processing CSV data and dates.
- Database: MongoDB Atlas for persistent data storage.

##### Relationships and Interactions
- The UI layer (pages and components) interacts with the state management contexts to manage and propagate user selections (like the current province).
- User actions (e.g., clicking on the map) trigger state updates via the SelectionContext and then display specific data charts/components accordingly.
- The UI components then interact with the API endpoints (using Axios or similar from the frontend) to fetch real-time and historical vaccination data.
- API endpoints use the Database utilities to connect to MongoDB, querying and returning data which is then processed and rendered by the frontend.
- Visual components include interactions between charts, maps, and modals that provide additional details, such as additional information pages and responsive UI interactions (animations with Framer Motion).

##### Architectural Patterns and Design Principles
- Full-Stack Separation: Clearly separate frontend page rendering and backend data/API handling.
- Componentization & Modularity: Breaking the UI into reusable components (e.g., charts, maps, tooltips).
- Context-based State Management: Using React Contexts to manage shared state across components.
- Integration of Third-party Libraries: Leveraging libraries like Chakra UI, Framer Motion, Recharts, and React Simple Maps to handle specific tasks.
- Testing and Mocks: The presence of __tests__ and __mocks__ directories shows an emphasis on testing and isolation of components.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend/UI Layer
    subgraph "Frontend/UI Layer"
        subgraph "Pages"
            AppPage["App Page (_app.tsx)"]
            DocumentPage["Document Page (_document.tsx)"]
            IndexPage["Index Page (index.tsx)"]
        end
        subgraph "Components"
            BarCharts["Bar Charts Section"]
            Histogram["Histogram Section"]
            Numbers["Numbers Section"]
            VaccineType["Vaccine Type Section"]
            MapComp["Map"]
            TitleComp["Title"]
            DoseInfo["Dose Info"]
            InfoModal["Info Modal"]
            MotionUtil["Motion & Animation"]
        end
    end

    %% State Management
    subgraph "State Management"
        DataContext["DataContext"]
        SelectionContext["SelectionContext"]
    end

    %% API/Data Layer
    subgraph "API/Data Layer"
        CurrentDataAPI["Current Data API"]
        HistoricDataIndex["Historic Data API Index"]
        HistoricDataProvince["Historic Data API Province"]
        DatabaseUtils["Database Connectivity Utils"]
    end

    %% Database
    MongoAtlas["MongoDB Atlas"]

    %% Relationships between Frontend and State Management
    AppPage -->|"loads"| BarCharts
    AppPage -->|"loads"| Histogram
    AppPage -->|"loads"| Numbers
    AppPage -->|"loads"| VaccineType
    IndexPage -->|"renders"| MapComp
    DocumentPage -->|"includes"| TitleComp

    DataContext -->|"provides data to"| BarCharts
    DataContext -->|"provides data to"| Histogram
    DataContext -->|"provides data to"| Numbers
    SelectionContext -->|"updates"| MapComp
    SelectionContext -->|"updates"| VaccineType

    %% Relationships between Components and API/Data Layer
    MapComp -->|"triggers request"| CurrentDataAPI
    BarCharts -->|"fetches data"| CurrentDataAPI
    Histogram -->|"fetches data"| HistoricDataIndex
    Numbers -->|"fetches data"| HistoricDataProvince
    VaccineType -->|"fetches data"| CurrentDataAPI

    %% Relationships within API/Data Layer and Database
    CurrentDataAPI -->|"queries"| DatabaseUtils
    HistoricDataIndex -->|"queries"| DatabaseUtils
    HistoricDataProvince -->|"queries"| DatabaseUtils
    DatabaseUtils -->|"connects to"| MongoAtlas

    %% Styling classes
    class AppPage,DocumentPage,IndexPage,BarCharts,Histogram,Numbers,VaccineType,MapComp,TitleComp,DoseInfo,InfoModal,MotionUtil frontend
    class DataContext,SelectionContext context
    class CurrentDataAPI,HistoricDataIndex,HistoricDataProvince,DatabaseUtils backend
    class MongoAtlas database

    %% Click Events
    click AppPage "https://github.com/nicopoore/argentina-vaccines/blob/main/src/pages/_app.tsx"
    click DocumentPage "https://github.com/nicopoore/argentina-vaccines/blob/main/src/pages/_document.tsx"
    click IndexPage "https://github.com/nicopoore/argentina-vaccines/blob/main/src/pages/index.tsx"
    click BarCharts "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/sections/BarChartsSection/index.tsx"
    click Histogram "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/sections/HistogramSection/index.tsx"
    click Numbers "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/sections/NumbersSection/index.tsx"
    click VaccineType "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/sections/VaccineTypeSection/index.tsx"
    click MapComp "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/Map/index.tsx"
    click TitleComp "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/Title/index.tsx"
    click DoseInfo "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/DoseInfo/index.tsx"
    click InfoModal "https://github.com/nicopoore/argentina-vaccines/blob/main/src/components/InfoModal/index.tsx"
    click MotionUtil "https://github.com/nicopoore/argentina-vaccines/tree/main/src/utils/MotionComponents"
    click CurrentDataAPI "https://github.com/nicopoore/argentina-vaccines/blob/main/src/pages/api/data.ts"
    click HistoricDataIndex "https://github.com/nicopoore/argentina-vaccines/blob/main/src/pages/api/historic_data/index.ts"
    click HistoricDataProvince "https://github.com/nicopoore/argentina-vaccines/blob/main/src/pages/api/historic_data/[...provinceNo].ts"
    click DatabaseUtils "https://github.com/nicopoore/argentina-vaccines/tree/main/src/utils/Database"
    click DataContext "https://github.com/nicopoore/argentina-vaccines/blob/main/src/utils/Context/DataContext.tsx"
    click SelectionContext "https://github.com/nicopoore/argentina-vaccines/blob/main/src/utils/Context/SelectionContext.tsx"

    %% Class Definitions for styling
    classDef frontend fill:#b3cde0,stroke:#6497b1,stroke-width:2px;
    classDef context fill:#dec3f0,stroke:#c8a2c8,stroke-width:2px;
    classDef backend fill:#ccebc5,stroke:#a8ddb5,stroke-width:2px;
    classDef database fill:#fddb92,stroke:#f2a0a0,stroke-width:2px;
```
