# develad/sufgical architecture

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

- Interactive diagram: https://gitdiagram.com/develad/sufgical
- Repository: https://github.com/develad/sufgical

## Overview

##### Main Components Structure

a) Client-Side Application (Single Page Application)
- The project is a Vite-based React application
- Uses TailwindCSS for styling
- Implements client-side routing
- Utilizes local storage for data persistence

##### Key Architectural Layers

**┌─ Presentation Layer ─────────────────────┐**
- Pages                                    │
- Welcome                              │
- Home                                 │
- Donuts                              │
- History                             │
- AddUser                             │
- ┘
- ↕
**┌─ Component Layer ──────────────────────┐**
- UI Components                       │
- Controls, Buttons               │
- Feature Components                  │
- DonutCard                       │
- HistoryCard                     │
- UsersList                       │
- ┘
- ↕
**┌─ State Management ──────────────────────┐**
- Context API                             │
- AppContext                          │
- ┘
- ↕
**┌─ Data Layer ────────────────────────────┐**
- Local Storage                        │
- Static Data                          │
- activities.js                     │
- donuts.js                        │
- Utilities                            │
- calculations.js                   │
- formatting.js                     │
- ┘

##### Data Flow Indicators

- Unidirectional data flow from AppContext to components
- User interaction flow between components and pages
- Data persistence flow to local storage

##### Component Relationships

Key relationships:
- Parent-child component hierarchy
- Context provider scope
- Layout component wrapping structure

##### The separation of concerns between UI components and business logic

- How user data is managed and persisted
- How calorie calculations flow through the system
- How the activity tracking system interfaces with the UI
- The relationship between donut selection and activity recommendations

This structure reflects a modern React application with clear separation of concerns and a focus on client-side functionality while maintaining user privacy through local storage.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Presentation Layer"
        Welcome["Welcome Page"]
        Home["Home Page"]
        Donuts["Donuts Page"]
        History["History Page"]
        AddUser["Add User Page"]
    end

    subgraph "Component Layer"
        direction TB
        subgraph "UI Components"
            Controls["Controls"]
            Buttons["Buttons"]
            CircleBtn["Circle Button"]
            RoundedBtn["Rounded Corners Button"]
        end

        subgraph "Feature Components"
            DonutCard["Donut Card"]
            HistoryCard["History Card"]
            UsersList["Users List"]
            ActivitiesList["Activities List"]
            TotalCalories["Total Calories"]
        end
    end

    subgraph "State Management"
        AppContext["App Context"]
    end

    subgraph "Data Layer"
        LocalStorage[(Local Storage)]
        subgraph "Static Data"
            Activities["Activities Data"]
            Donuts["Donuts Data"]
        end
        subgraph "Utilities"
            Calculations["Calculations"]
            Formatting["Formatting"]
        end
    end

    subgraph "Layout Components"
        AppLayout["App Layout"]
        BasePageLayout["Base Page Layout"]
    end

    %% Relationships
    AppLayout --> BasePageLayout
    BasePageLayout --> Welcome
    BasePageLayout --> Home
    BasePageLayout --> Donuts
    BasePageLayout --> History
    BasePageLayout --> AddUser

    AppContext --> Welcome
    AppContext --> Home
    AppContext --> Donuts
    AppContext --> History
    AppContext --> AddUser

    Home --> ActivitiesList
    Home --> TotalCalories
    Donuts --> DonutCard
    History --> HistoryCard
    AddUser --> UsersList

    AppContext <--> LocalStorage

    %% Click events
    click Welcome "https://github.com/develad/sufgical/blob/main/src/pages/Welcome.jsx"
    click Home "https://github.com/develad/sufgical/blob/main/src/pages/Home.jsx"
    click Donuts "https://github.com/develad/sufgical/blob/main/src/pages/Donuts.jsx"
    click History "https://github.com/develad/sufgical/blob/main/src/pages/History.jsx"
    click AddUser "https://github.com/develad/sufgical/blob/main/src/pages/AddUser.jsx"
    click Controls "https://github.com/develad/sufgical/blob/main/src/components/Ui/Controls.jsx"
    click Buttons "https://github.com/develad/sufgical/blob/main/src/components/Buttons/Buttons.jsx"
    click CircleBtn "https://github.com/develad/sufgical/blob/main/src/components/Buttons/CircleButton.jsx"
    click RoundedBtn "https://github.com/develad/sufgical/blob/main/src/components/Buttons/RoundedCornersButton.jsx"
    click DonutCard "https://github.com/develad/sufgical/blob/main/src/components/Donuts/DonutCard.jsx"
    click HistoryCard "https://github.com/develad/sufgical/blob/main/src/components/History/HistoryCard.tsx"
    click UsersList "https://github.com/develad/sufgical/blob/main/src/components/AddUser/UsersList.jsx"
    click ActivitiesList "https://github.com/develad/sufgical/blob/main/src/components/HomePage/ActivitiesList.jsx"
    click TotalCalories "https://github.com/develad/sufgical/blob/main/src/components/HomePage/TotalCalories.jsx"
    click AppContext "https://github.com/develad/sufgical/blob/main/src/context/AppContext.jsx"
    click Activities "https://github.com/develad/sufgical/blob/main/src/data/activites.js"
    click Donuts "https://github.com/develad/sufgical/blob/main/src/data/donuts.js"
    click Calculations "https://github.com/develad/sufgical/blob/main/src/utils/calculations.js"
    click Formatting "https://github.com/develad/sufgical/blob/main/src/utils/formatting.js"
    click AppLayout "https://github.com/develad/sufgical/blob/main/src/layoutes/AppLayout.jsx"
    click BasePageLayout "https://github.com/develad/sufgical/blob/main/src/layoutes/BasePageLayout.jsx"

    %% Styling
    classDef page fill:#2563eb,color:white
    classDef component fill:#22c55e,color:white
    classDef state fill:#eab308,color:black
    classDef data fill:#9333ea,color:white
    classDef util fill:#6b7280,color:white
    classDef layout fill:#475569,color:white

    class Welcome,Home,Donuts,History,AddUser page
    class Controls,Buttons,CircleBtn,RoundedBtn,DonutCard,HistoryCard,UsersList,ActivitiesList,TotalCalories component
    class AppContext state
    class LocalStorage,Activities,Donuts data
    class Calculations,Formatting util
    class AppLayout,BasePageLayout layout
```
