# rohtanza/ramadanflow architecture

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

- Interactive diagram: https://gitdiagram.com/rohtanza/ramadanflow
- Repository: https://github.com/rohtanza/ramadanflow

## Overview

##### Main components
a. Frontend (React/Vite/Tailwind)
b. Backend API (Node.js/Express)
c. Database (MongoDB via Mongoose models)
d. Static data sources (JSON files for Azkar in backend/data)
e. External services (optional: third-party Hijri calendar or prayer-time API if used)
f. Authentication (JWT or session via auth middleware)

##### Relationships and data-flows
- Browser/Client ↔ React SPA communicates over HTTPS with the Express API
- Express routes call service layer → data layer (Mongoose models ↔ MongoDB)
- Services may read static JSON files for Azkar or call external APIs in calendarService
- Auth middleware guards protected routes, issuing/verifying JWTs stored in browser localStorage/context
- User actions (e.g., “Log Prayer,” “Favorite Hadith”) write to respective collections via models

##### Architectural patterns
- Layered architecture in backend:
– Routes (API endpoints)
– Middleware (auth.js)
– Services (business logic)
– Models (data persistence)
- React uses Context API (AuthContext) for global state and React Router for page navigation
- Separation of concerns between static assets (public) and dynamic SPA code (src)
- Use of JSON data files for Azkar lists rather than external DB tables

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Client (Browser & React/Vite/Tailwind)"]:::frontend

    subgraph "Frontend Layer"
        Main["main.jsx"]:::frontend
        AppShell["App.jsx"]:::frontend
        AuthCtx["AuthContext.jsx"]:::frontend
        subgraph "Pages"
            AzkarPage["AzkarLibrary.jsx"]:::frontend
            DashPage["Dashboard.jsx"]:::frontend
            HijriPage["HijriCalendar.jsx"]:::frontend
            LibraryPage["LibraryPage.jsx"]:::frontend
            LoginPage["Login.jsx"]:::frontend
            PrayerPage["PrayerTimes.jsx"]:::frontend
            QuranPage["QuranReader.jsx"]:::frontend
            RegisterPage["Register.jsx"]:::frontend
            SalahPage["SalahTracker.jsx"]:::frontend
            TasbihPage["TasbihCounter.jsx"]:::frontend
        end
        subgraph "API Services"
            AuthServiceFE["authService.js"]:::service
            AzkarServiceFE["azkarService.js"]:::service
            CalServiceFE["calendarService.js"]:::service
            LibraryServiceFE["libraryService.js"]:::service
            QuranServiceFE["quranService.js"]:::service
            TasbihServiceFE["tasbihService.js"]:::service
        end
    end

    subgraph "API Server (Node.js/Express)"
        Server["server.js"]:::backend
        subgraph "Routes"
            AuthR["auth.js"]:::backend
            AzkarR["azkar.js"]:::backend
            AzkarApiR["azkarApi.js"]:::backend
            CalR["calendar.js"]:::backend
            DuaR["dua.js"]:::backend
            LibraryR["library.js"]:::backend
            PrayerR["prayer.js"]:::backend
            SalahR["salah.js"]:::backend
            QuranR["quran.js"]:::backend
            TasbihR["tasbih.js"]:::backend
        end
        AuthMR["auth.js (middleware)"]:::middleware
        subgraph "Services"
            AzkarS["azkarService.js"]:::service
            CalS["calendarService.js"]:::service
            DuaS["duaService.js"]:::service
            LibraryS["libraryService.js"]:::service
            PrayerS["prayerService.js"]:::service
            QuranS["quranService.js"]:::service
            TasbihS["tasbihService.js"]:::service
        end
        subgraph "Models"
            UserM["User.js"]:::model
            PrayerLogM["PrayerLog.js"]:::model
            PrayerSettingM["PrayerSetting.js"]:::model
            AdhkarLogM["AdhkarLog.js"]:::model
            FavoriteM["FavoriteHadith.js"]:::model
            RecProgressM["RecitationProgress.js"]:::model
            TasbihCounterM["TasbihCounter.js"]:::model
        end
        StaticData["Azkar JSON Files"]:::data
    end

    Database[(MongoDB)]:::db

    subgraph "External APIs"
        External["Hijri/prayer API"]:::external
    end

    Client -->|"HTTPS requests\nJWT in headers"| Main
    Main --> AppShell
    AppShell --> AuthCtx
    AppShell --> AzkarPage
    AppShell --> DashPage
    AppShell --> HijriPage
    AppShell --> LibraryPage
    AppShell --> LoginPage
    AppShell --> PrayerPage
    AppShell --> QuranPage
    AppShell --> RegisterPage
    AppShell --> SalahPage
    AppShell --> TasbihPage

    AzkarPage --> AzkarServiceFE
    DashPage --> AuthServiceFE
    HijriPage --> CalServiceFE
    LibraryPage --> LibraryServiceFE
    PrayerPage --> PrayerServiceFE
    QuranPage --> QuranServiceFE
    SalahPage --> TasbihServiceFE
    TasbihPage --> TasbihServiceFE
    LoginPage --> AuthServiceFE
    RegisterPage --> AuthServiceFE

    Main -->|"API call"| Server
    Server --> AuthR
    Server --> AzkarR
    Server --> AzkarApiR
    Server --> CalR
    Server --> DuaR
    Server --> LibraryR
    Server --> PrayerR
    Server --> SalahR
    Server --> QuranR
    Server --> TasbihR

    AuthR --> AuthMR
    AzkarR --> AuthMR
    CalR --> AuthMR
    DuaR --> AuthMR
    LibraryR --> AuthMR
    PrayerR --> AuthMR
    SalahR --> AuthMR
    QuranR --> AuthMR
    TasbihR --> AuthMR

    AuthR --> AzkarS
    AzkarR --> AzkarS
    AzkarApiR --> AzkarS
    CalR --> CalS
    DuaR --> DuaS
    LibraryR --> LibraryS
    PrayerR --> PrayerS
    SalahR --> PrayerS
    QuranR --> QuranS
    TasbihR --> TasbihS

    AzkarS --> StaticData
    CalS --> External
    DuaS --> Database
    LibraryS --> Database
    PrayerS --> Database
    QuranS --> Database
    TasbihS --> Database
    AzkarS --> Database

    AzkarS --> UserM
    CalS --> UserM
    DuaS --> UserM
    LibraryS --> UserM
    PrayerS --> PrayerLogM
    PrayerS --> PrayerSettingM
    SalahS --> PrayerLogM
    QuranS --> RecProgressM
    TasbihS --> TasbihCounterM
    AzkarS --> AdhkarLogM
    AzkarS --> FavoriteM

    UserM --> Database
    PrayerLogM --> Database
    PrayerSettingM --> Database
    AdhkarLogM --> Database
    FavoriteM --> Database
    RecProgressM --> Database
    TasbihCounterM --> Database

    click Main "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/main.jsx"
    click AppShell "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/App.jsx"
    click AuthCtx "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/context/AuthContext.jsx"
    click AzkarPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/AzkarLibrary.jsx"
    click DashPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/Dashboard.jsx"
    click HijriPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/HijriCalendar.jsx"
    click LibraryPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/LibraryPage.jsx"
    click LoginPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/Login.jsx"
    click PrayerPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/PrayerTimes.jsx"
    click QuranPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/QuranReader.jsx"
    click RegisterPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/Register.jsx"
    click SalahPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/SalahTracker.jsx"
    click TasbihPage "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/pages/TasbihCounter.jsx"
    click AuthServiceFE "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/services/authService.js"
    click AzkarServiceFE "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/services/azkarService.js"
    click CalServiceFE "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/services/calendarService.js"
    click LibraryServiceFE "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/services/libraryService.js"
    click QuranServiceFE "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/services/quranService.js"
    click TasbihServiceFE "https://github.com/rohtanza/ramadanflow/blob/main/frontend/src/services/tasbihService.js"
    click Server "https://github.com/rohtanza/ramadanflow/blob/main/backend/server.js"
    click AuthR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/auth.js"
    click AzkarR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/azkar.js"
    click AzkarApiR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/azkarApi.js"
    click CalR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/calendar.js"
    click DuaR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/dua.js"
    click LibraryR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/library.js"
    click PrayerR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/prayer.js"
    click SalahR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/salah.js"
    click QuranR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/quran.js"
    click TasbihR "https://github.com/rohtanza/ramadanflow/blob/main/backend/routes/tasbih.js"
    click AuthMR "https://github.com/rohtanza/ramadanflow/blob/main/backend/middleware/auth.js"
    click AzkarS "https://github.com/rohtanza/ramadanflow/blob/main/backend/services/azkarService.js"
    click CalS "https://github.com/rohtanza/ramadanflow/blob/main/backend/services/calendarService.js"
    click DuaS "https://github.com/rohtanza/ramadanflow/blob/main/backend/services/duaService.js"
    click LibraryS "https://github.com/rohtanza/ramadanflow/blob/main/backend/services/libraryService.js"
    click PrayerS "https://github.com/rohtanza/ramadanflow/blob/main/backend/services/prayerService.js"
    click QuranS "https://github.com/rohtanza/ramadanflow/blob/main/backend/services/quranService.js"
    click TasbihS "https://github.com/rohtanza/ramadanflow/blob/main/backend/services/tasbihService.js"
    click UserM "https://github.com/rohtanza/ramadanflow/blob/main/backend/models/User.js"
    click PrayerLogM "https://github.com/rohtanza/ramadanflow/blob/main/backend/models/PrayerLog.js"
    click PrayerSettingM "https://github.com/rohtanza/ramadanflow/blob/main/backend/models/PrayerSetting.js"
    click AdhkarLogM "https://github.com/rohtanza/ramadanflow/blob/main/backend/models/AdhkarLog.js"
    click FavoriteM "https://github.com/rohtanza/ramadanflow/blob/main/backend/models/FavoriteHadith.js"
    click RecProgressM "https://github.com/rohtanza/ramadanflow/blob/main/backend/models/RecitationProgress.js"
    click TasbihCounterM "https://github.com/rohtanza/ramadanflow/blob/main/backend/models/TasbihCounter.js"
    click StaticData "https://github.com/rohtanza/ramadanflow/tree/main/backend/data/"

    classDef frontend fill:#f9f,stroke:#333,stroke-width:1px
    classDef backend fill:#bbf,stroke:#333,stroke-width:1px
    classDef service fill:#bfb,stroke:#333,stroke-width:1px
    classDef model fill:#fbf,stroke:#333,stroke-width:1px
    classDef data fill:#ffb,stroke:#333,stroke-width:1px
    classDef db fill:#fbb,stroke:#333,stroke-width:1px,shape:cylinder
    classDef middleware fill:#ff0,stroke:#333,stroke-width:1px
    classDef external fill:#eee,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
```
