# astarub/campus_app architecture

> Architecture diagram of the GitHub repository astarub/campus_app, 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/astarub/campus_app
- Repository: https://github.com/astarub/campus_app

## Overview

##### Main Components
- Mobile Client (Flutter App)
– Presentation Layer (UI pages, widgets under lib/pages & lib/utils/widgets)
– Domain Layer (UseCases under lib/pages/*/…_usecases.dart)
– Data Layer
· Repositories (lib/core/backend_repository.dart, lib/pages/*/…_repository.dart)
· Data Sources (HTTP clients under lib/pages/*/…_datasource.dart, lib/core/backend)
· Entities & Mappers (…_entity.dart & generated serializers)
– Core Services & Utilities (DI in lib/core/injection.dart, settings, themes, l10n, dio_utils)
– Platform Plug-ins (Firebase, Google-Services—firebase_options.dart, android/app/google-services.json, iOS Podfile)
– Assets & Localization (assets/animations, fonts, img; l10n arb files)

- Backend Services
– Campus-App Backend (custom APIs for user data, timetable, rubnews, wallet)
– Mensa Scraper (scrapes cafeteria menus; uptime badge in README)
– Forgerock Auth Service (OAuth/OpenID; documented in docs/wiki/Utilities/forgerock_api.md)
– Moodle API (student information; docs/wiki/Utilities/moodle_api.md)
– RubNews Feed (news XML endpoint; docs/wiki/Pages/rubnews.md)

- Third-Party & Cloud
– Firebase (Analytics, Crashlytics, possibly Messaging)
– Google-Services (iOS/Android configuration)

##### Relationships & Data Flows
- User taps UI → Presentation Layer
- Presentation calls Domain UseCase → uses Repository interface
- Repository delegates to DataSource → HTTP calls via Dio (lib/utils/dio_utils.dart)
- DataSource calls appropriate backend (Campus Backend, Mensa Scraper, etc.)
- Responses deserialized into Entities → passed back up to Presentation
- DI Container wires UseCases, Repositories, DataSources at app startup (main.dart → injection.dart)
- Localization subsystem loads l10n/*.arb based on user locale
- Assets (animations, fonts) loaded by UI widgets

##### Architectural Patterns & Principles
- Layered/Onion Architecture: Presentation → Domain → Data
- Clean Architecture with UseCases and Repositories
- Dependency Injection (singletons wired in lib/core/injection.dart)
- Code generation for serialization (built_value or json_serializable via *.g.dart)
- Platform abstraction via Flutter plugins (Firebase, native Android/iOS code in android/app & ios/Runner)

##### Technologies & Frameworks to Annotate
- Flutter & Dart (lib/, android/, ios/, web/)
- Dio for HTTP
- json_serializable (generated *.g.dart)
- Forgerock Auth, Moodle API clients
- Firebase SDK (Crashlytics, Analytics)
- Gradle (Android), CocoaPods (iOS)

##### Final Checklist
- Clear labels (e.g., “CalendarUseCase,” “MensaDataSource,” “Firebase Crashlytics”)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Mobile Client Layers
    subgraph "Mobile Client"
        subgraph "UI Layer" 
            UI["Pages (lib/pages/)"]:::ui
            Widgets["Widgets (lib/utils/widgets/)"]:::ui
        end
        subgraph "Domain Layer"
            CU1["CalendarUseCase"]:::domain
            CU2["NewsUseCase"]:::domain
            CU3["MensaUseCase"]:::domain
            CU4["TicketUseCase"]:::domain
        end
        subgraph "Data Layer"
            R1["BackendRepository (lib/core/backend_repository.dart)"]:::data
            R2["CalendarRepository"]:::data
            R3["NewsRepository"]:::data
            R4["MensaRepository"]:::data
            R5["TicketRepository"]:::data
            DS0["Core Backend DataSource (lib/core/backend/)"]:::data
            DS1["CalendarDataSource"]:::data
            DS2["NewsDataSource"]:::data
            DS3["MensaDataSource"]:::data
            DS4["TicketDataSource"]:::data
        end
        subgraph "Core Services & Utils"
            DI["Injection (lib/core/injection.dart)"]:::core
            Dio["Dio Utils (lib/utils/dio_utils.dart)"]:::core
            Settings["Settings (lib/core/settings.dart)"]:::core
            Themes["Themes (lib/core/themes.dart)"]:::core
            L10n["Localization (lib/l10n/l10n.dart)"]:::core
        end
        subgraph "Platform Plugins & Config"
            FBOpt["Firebase Options (lib/firebase_options.dart)"]:::plugin
            AndroidGS["Android config (android/app/google-services.json)"]:::plugin
            iOSGS["iOS config (ios/Runner/GoogleService-Info.plist)"]:::plugin
            Pod["Podfile (ios/Podfile)"]:::plugin
        end
        subgraph "Assets & Resources"
            Anim["Animations (assets/animations/)"]:::assets
            Fonts["Fonts (assets/fonts/)"]:::assets
            Img["Images (assets/img/icons/)"]:::assets
            ARB["ARB files (assets/l10n/)"]:::assets
        end
    end

    %% External Backend Services
    subgraph "Backend Services"
        CB["Campus-App Backend API"]:::ext
        MS["Mensa Scraper"]:::ext
        FA["Forgerock Auth Service"]:::ext
        MD["Moodle API Client"]:::ext
        RN["RubNews Feed"]:::ext
    end

    %% Documentation & CI/CD
    subgraph "Docs & CI/CD"
        Docs1["Backend Docs (docs/wiki/Backend.md)"]:::docs
        Docs2["Forgerock API (docs/wiki/Utilities/forgerock_api.md)"]:::docs
        Docs3["Moodle API (docs/wiki/Utilities/moodle_api.md)"]:::docs
        Docs4["RubNews Docs (docs/wiki/Pages/rubnews.md)"]:::docs
        Docs5["Mensa HTTP Setup (docs/wiki/Utilities/dio.md)"]:::docs
        CI["GitHub Actions (.github/workflows/documentation.yml)"]:::docs
        Build["Build Script (docs/build_wiki.sh)"]:::docs
    end

    %% Flows
    UI --> CU1
    UI --> CU2
    UI --> CU3
    UI --> CU4
    Widgets --> UI
    CU1 --> R2
    CU2 --> R3
    CU3 --> R4
    CU4 --> R5
    R1 --> DS0
    R2 --> DS1
    R3 --> DS2
    R4 --> DS3
    R5 --> DS4
    DS0 --> CB
    DS1 --> CB
    DS2 --> MS
    DS3 --> MS
    DS4 --> CB
    DS0 --> FA
    DS0 --> MD
    DS2 --> RN

    %% DI wiring
    DI --> CU1
    DI --> CU2
    DI --> CU3
    DI --> CU4
    DI --> R1
    DI --> R2
    DI --> R3
    DI --> R4
    DI --> R5
    DI --> DS0
    DI --> DS1
    DI --> DS2
    DI --> DS3
    DI --> DS4

    %% Plugins & Assets usage
    FBOpt --> UI
    AndroidGS --> UI
    iOSGS --> UI
    Pod --> UI
    Anim --> UI
    Fonts --> UI
    Img --> UI
    ARB --> L10n

    %% Docs links
    Docs1 --> CB
    Docs5 --> MS
    Docs2 --> FA
    Docs3 --> MD
    Docs4 --> RN
    CI --> Docs1
    Build --> Docs1

    %% Click Events
    click UI "https://github.com/astarub/campus_app/tree/master/lib/pages/"
    click Widgets "https://github.com/astarub/campus_app/tree/master/lib/utils/widgets/"
    click CU1 "https://github.com/astarub/campus_app/blob/master/lib/pages/calendar/calendar_usecases.dart"
    click CU2 "https://github.com/astarub/campus_app/blob/master/lib/pages/feed/news/news_usecases.dart"
    click CU3 "https://github.com/astarub/campus_app/blob/master/lib/pages/mensa/mensa_usecases.dart"
    click CU4 "https://github.com/astarub/campus_app/blob/master/lib/pages/wallet/ticket/ticket_usecases.dart"
    click R1 "https://github.com/astarub/campus_app/blob/master/lib/core/backend_repository.dart"
    click R2 "https://github.com/astarub/campus_app/blob/master/lib/pages/calendar/calendar_repository.dart"
    click R3 "https://github.com/astarub/campus_app/blob/master/lib/pages/feed/news/news_repository.dart"
    click R4 "https://github.com/astarub/campus_app/blob/master/lib/pages/mensa/mensa_repository.dart"
    click R5 "https://github.com/astarub/campus_app/blob/master/lib/pages/wallet/ticket/ticket_repository.dart"
    click DS0 "https://github.com/astarub/campus_app/tree/master/lib/core/backend/"
    click DS1 "https://github.com/astarub/campus_app/blob/master/lib/pages/calendar/calendar_datasource.dart"
    click DS2 "https://github.com/astarub/campus_app/blob/master/lib/pages/feed/news/news_datasource.dart"
    click DS3 "https://github.com/astarub/campus_app/blob/master/lib/pages/mensa/mensa_datasource.dart"
    click DS4 "https://github.com/astarub/campus_app/blob/master/lib/pages/wallet/ticket/ticket_datasource.dart"
    click DI "https://github.com/astarub/campus_app/blob/master/lib/core/injection.dart"
    click Dio "https://github.com/astarub/campus_app/blob/master/lib/utils/dio_utils.dart"
    click Settings "https://github.com/astarub/campus_app/blob/master/lib/core/settings.dart"
    click Themes "https://github.com/astarub/campus_app/blob/master/lib/core/themes.dart"
    click L10n "https://github.com/astarub/campus_app/blob/master/lib/l10n/l10n.dart"
    click FBOpt "https://github.com/astarub/campus_app/blob/master/lib/firebase_options.dart"
    click AndroidGS "https://github.com/astarub/campus_app/blob/master/android/app/google-services.json"
    click iOSGS "https://github.com/astarub/campus_app/blob/master/ios/Runner/GoogleService-Info.plist"
    click Pod "https://github.com/astarub/campus_app/tree/master/ios/Podfile"
    click Anim "https://github.com/astarub/campus_app/tree/master/assets/animations/"
    click Fonts "https://github.com/astarub/campus_app/tree/master/assets/fonts/"
    click Img "https://github.com/astarub/campus_app/tree/master/assets/img/icons/"
    click ARB "https://github.com/astarub/campus_app/tree/master/assets/l10n/"
    click Docs1 "https://github.com/astarub/campus_app/blob/master/docs/wiki/Backend.md"
    click Docs2 "https://github.com/astarub/campus_app/blob/master/docs/wiki/Utilities/forgerock_api.md"
    click Docs3 "https://github.com/astarub/campus_app/blob/master/docs/wiki/Utilities/moodle_api.md"
    click Docs4 "https://github.com/astarub/campus_app/blob/master/docs/wiki/Pages/rubnews.md"
    click Docs5 "https://github.com/astarub/campus_app/blob/master/docs/wiki/Utilities/dio.md"
    click CI "https://github.com/astarub/campus_app/blob/master/.github/workflows/documentation.yml"
    click Build "https://github.com/astarub/campus_app/blob/master/docs/build_wiki.sh"

    %% Styles
    classDef ui fill:#8dd3c7,stroke:#333,stroke-width:1px
    classDef domain fill:#ffffb3,stroke:#333,stroke-width:1px
    classDef data fill:#bebada,stroke:#333,stroke-width:1px
    classDef ext fill:#fb8072,stroke:#333,stroke-width:1px
    classDef core fill:#80b1d3,stroke:#333,stroke-width:1px
    classDef plugin fill:#fdb462,stroke:#333,stroke-width:1px
    classDef assets fill:#b3de69,stroke:#333,stroke-width:1px
    classDef docs fill:#fccde5,stroke:#333,stroke-width:1px
```
