# aydh/symptom-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/aydh/symptom-tracker
- Repository: https://github.com/aydh/symptom-tracker

## Overview

##### Project type and purpose
- This is a single‐page React application (“Symptom Tracker”) that uses Firebase as a backend (Auth and Firestore) and is deployed via Firebase Hosting (and optionally Netlify).
- Users can sign up/log in, record symptoms over date ranges, view tables, and analyze symptom trends.

##### File structure
- Top level: configuration files for GitHub Actions (.github), Firebase (.firebaserc, firebase.json), Netlify (netlify.toml), and package definitions (package.json).
- public/: static assets (index.html, manifest, robots.txt).
- src/: React source code.
- App.js & index.js: entry points.
- components/: UI modules (Login, Signup, SymptomTracker, etc.).
- firebase.js: initializes Firebase SDK (Auth + Firestore).
- utils/: helper functions (caching, date formatting, dynamic fields, styling).
- theme.js: design/theme settings.

##### README for additional insights
- Basic install/run instructions (“npm install”, “npm start”).
- No explicit backend server code—Firebase is the BaaS layer.

##### Main components & interactions
a. Components:
- Client Browser (user’s device)
- React SPA (App shell with component submodules)
- Utility layer (cacheUtils, dateUtils, etc.)
- Firebase Services (Authentication, Firestore Database)
- CI/CD Pipeline (GitHub Actions)
- Hosting (Firebase Hosting and/or Netlify)
b. Interactions:
- Browser loads React SPA from Hosting.
- SPA (via firebase.js) calls Firebase Auth for sign‐in/up/out.
- SPA reads/writes symptom data to Firestore.
- cacheUtils may store local data (localStorage) for offline or performance.
- GitHub pushes trigger GitHub Actions → deploy updated code to Firebase Hosting.
c. Architectural patterns/design principles:
- Client–Server separation via BaaS.
- Component‐based UI (React).
- Utility library for cross‐cutting concerns (caching, date handling, styling).
d. Technologies/frameworks:
- React (create‐react‐app structure)
- Firebase SDK (Auth + Firestore + Hosting)
- GitHub Actions for CI/CD
- Netlify (alternative hosting)
- Standard web stack (HTML5, JS, CSS via React)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "User Tier"
        Browser["User Browser"]:::frontend
    end

    subgraph "Frontend Tier"
        SPA["React SPA<br/>(App.js, index.js)"]:::frontend
        subgraph "Authentication UI"
            Login["Login"]:::frontend
            Signup["Signup"]:::frontend
            Logout["Logout"]:::frontend
        end
        subgraph "SymptomTracker UI"
            SymptomTracker["SymptomTracker"]:::frontend
            SymptomTable["SymptomTable"]:::frontend
            SymptomAnalysis["SymptomAnalysis"]:::frontend
            DateRangeSelector["DateRangeSelector"]:::frontend
            DynamicFieldsManager["DynamicFieldsManager"]:::frontend
            ClearCacheButton["ClearCacheButton"]:::frontend
        end
        subgraph "Utility Layer"
            cacheUtils["cacheUtils"]:::frontend
            dateUtils["dateUtils"]:::frontend
            dynamicFieldsUtils["dynamicFieldsUtils"]:::frontend
            flagStyleUtils["flagStyleUtils"]:::frontend
            symptomUtils["symptomUtils"]:::frontend
        end
        FirebaseJS["Firebase SDK<br/>(firebase.js)"]:::frontend
    end

    subgraph "Backend Services"
        Auth["Firebase Auth"]:::backend
        Firestore["Firestore Database"]:::backend
    end

    subgraph "CI/CD & Hosting"
        Repo["GitHub Repo"]:::devops
        subgraph "Workflows"
            W1["firebase-hosting-merge.yml"]:::devops
            W2["firebase-hosting-pull-request.yml"]:::devops
        end
        Actions["GitHub Actions"]:::devops
        subgraph "Hosting Config"
            FBR["firebase.json"]:::devops
            FRC[".firebaserc"]:::devops
            NFT["netlify.toml"]:::devops
        end
        Hosting["Firebase Hosting"]:::devops
        Netlify["Netlify"]:::devops
    end

    Browser -->|loads| SPA
    SPA -->|renders| Login
    SPA -->|renders| Signup
    SPA -->|renders| Logout
    SPA -->|renders| SymptomTracker
    SPA -->|renders| SymptomTable
    SPA -->|renders| SymptomAnalysis
    SPA -->|renders| DateRangeSelector
    SPA -->|renders| DynamicFieldsManager
    SPA -->|renders| ClearCacheButton

    Login --> FirebaseJS
    Signup --> FirebaseJS
    Logout --> FirebaseJS
    SymptomTracker --> FirebaseJS
    SymptomTable --> FirebaseJS
    SymptomAnalysis --> FirebaseJS
    DateRangeSelector --> FirebaseJS
    DynamicFieldsManager --> FirebaseJS
    ClearCacheButton --> cacheUtils

    cacheUtils --> FirebaseJS
    dateUtils --> SPA
    dynamicFieldsUtils --> SPA
    flagStyleUtils --> SPA
    symptomUtils --> SPA

    FirebaseJS -->|Auth API calls| Auth
    FirebaseJS -->|Read/write symptom data| Firestore

    Repo --> W1
    Repo --> W2
    W1 --> Actions
    W2 --> Actions
    Actions --> Hosting
    Actions --> Netlify
    Hosting -->|serves SPA| Browser
    Netlify -->|serves SPA| Browser

    classDef frontend fill:#B3CDE3,stroke:#2B579A,color:#000;
    classDef backend fill:#C7E9C0,stroke:#238B45,color:#000;
    classDef devops fill:#FEC091,stroke:#D35A00,color:#000;

    click SPA "https://github.com/aydh/symptom-tracker/blob/main/src/index.js"
    click SPA "https://github.com/aydh/symptom-tracker/blob/main/src/App.js"
    click Login "https://github.com/aydh/symptom-tracker/blob/main/src/components/Login.js"
    click Signup "https://github.com/aydh/symptom-tracker/blob/main/src/components/Signup.js"
    click Logout "https://github.com/aydh/symptom-tracker/blob/main/src/components/Logout.js"
    click SymptomTracker "https://github.com/aydh/symptom-tracker/blob/main/src/components/SymptomTracker.js"
    click SymptomTable "https://github.com/aydh/symptom-tracker/blob/main/src/components/SymptomTable.js"
    click SymptomAnalysis "https://github.com/aydh/symptom-tracker/blob/main/src/components/SymptomAnalysis.js"
    click DateRangeSelector "https://github.com/aydh/symptom-tracker/blob/main/src/components/DateRangeSelector.js"
    click DynamicFieldsManager "https://github.com/aydh/symptom-tracker/blob/main/src/components/DynamicFieldsManager.js"
    click ClearCacheButton "https://github.com/aydh/symptom-tracker/blob/main/src/components/ClearCacheButton.js"
    click cacheUtils "https://github.com/aydh/symptom-tracker/blob/main/src/utils/cacheUtils.js"
    click dateUtils "https://github.com/aydh/symptom-tracker/blob/main/src/utils/dateUtils.js"
    click dynamicFieldsUtils "https://github.com/aydh/symptom-tracker/blob/main/src/utils/dynamicFieldsUtils.js"
    click flagStyleUtils "https://github.com/aydh/symptom-tracker/blob/main/src/utils/flagStyleUtils.js"
    click symptomUtils "https://github.com/aydh/symptom-tracker/blob/main/src/utils/symptomUtils.js"
    click FirebaseJS "https://github.com/aydh/symptom-tracker/blob/main/src/firebase.js"
    click W1 "https://github.com/aydh/symptom-tracker/blob/main/.github/workflows/firebase-hosting-merge.yml"
    click W2 "https://github.com/aydh/symptom-tracker/blob/main/.github/workflows/firebase-hosting-pull-request.yml"
    click FBR "https://github.com/aydh/symptom-tracker/blob/main/firebase.json"
    click FRC "https://github.com/aydh/symptom-tracker/blob/main/.firebaserc"
    click NFT "https://github.com/aydh/symptom-tracker/blob/main/netlify.toml"
```
