# bsoc-bitbyte/digigate architecture

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

- Interactive diagram: https://gitdiagram.com/bsoc-bitbyte/digigate
- Repository: https://github.com/bsoc-bitbyte/digigate

## Overview

##### Project type and purpose
- DigiGate is a full-stack Android application (Kotlin + Jetpack Compose) following an MVVM pattern.
- Purpose: enable students to generate QR passes, guards to scan them, and admins to view real-time entry logs, all backed by Firebase services.

##### File structure
- Top-level “app” module contains the entire Android codebase.
- src/main/java/com/tpc/digigate/application: custom Application class for Hilt setup
- src/main/java/com/tpc/digigate/data: data layer (Firebase auth & Firestore, local Room/ DataStore)
- src/main/java/com/tpc/digigate/domain: business models, repository interfaces, and use cases
- src/main/java/com/tpc/digigate/di: Hilt modules for dependency injection
- src/main/java/com/tpc/digigate/ui: UI layer (components, navigation, screens, view models)
- Build scripts, ProGuard rules, and resources are standard for Android.

##### README for additional insights
- Confirms MVVM + StateFlow, Jetpack Navigation, Hilt, Firebase Auth/Firestore/Storage.
- Three user roles/flows: Students (QR generation), Guards (QR scanning), Admins (dashboard).

a. Main components:
- Android App (UI Layer: Compose Screens + Navigation)
- ViewModel Layer (StateFlow + live data)
- Domain Layer (UseCases + Models)
- Data Layer:
– Firebase Auth (Auth service)
– Firebase Firestore (real-time logs)
– Firebase Storage (profile pics or scanned data)
– Local Storage (Room DB for caching history, DataStore for preferences)
- External Services: Firebase suite
- Roles / Clients: Student Device, Guard Device, Admin Dashboard (either within same app or web console)
b. Relationships and interactions:
1. UI → ViewModel: user actions (generate QR, scan QR, view logs)
2. ViewModel → UseCase: dispatch business logic
3. UseCase → Repository Interface (domain)
4. Repository Implementation (data) → Data Sources (Firebase, Room, DataStore)
5. Firebase Firestore ↔ App: push real-time updates, Admin pulls logs
6. Local DB / DataStore: read/write for offline cache and preferences
c. Architectural patterns and principles:
– MVVM: clear separation of UI, business logic, and data
– Clean architecture layering: UI → domain → data
– Dependency injection via Hilt to decouple implementations
– Single-source-of-truth: Firestore + local cache
d. Key technologies:
– Kotlin + Jetpack Compose (UI)
– StateFlow (reactive state)
– Hilt (DI)
– Jetpack Navigation 3
– Firebase Auth, Firestore, Storage
– Room (AppDatabase) & DataStore (AppPreferences)

##### Elements
- Labels: name each component (e.g., “LoginViewModel”, “AuthRepositoryImpl”, “FirestoreDataSource”)
- Rectangles for code modules/layers
- Clouds for external services (Firebase Auth/Firestore/Storage)

##### Detail without overthinking
- Break the system into these core layers and components.
- Every layer’s components and how they communicate.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Application & DI Layer
    subgraph "Application Layer"
        AGG["DigiGateApplication"]:::data
        DM1["AppModule"]:::data
        DM2["AuthModule"]:::data
    end
    AGG --> DM1
    AGG --> DM2
    click AGG "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/application/DigiGateApplication.kt"
    click DM1 "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/di/AppModule.kt"
    click DM2 "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/di/AuthModule.kt"

    %% UI Layer
    subgraph "UI Layer" 
        direction TB
        NAV["AppNavDisplay"]:::ui
        AUTHNAV["AuthNavDisplay"]:::ui
        SCRN["Screen.kt"]:::ui

        subgraph "Authentication Screens"
            direction TB
            LSC["LoginScreen"]:::ui
            RSC["RegisterScreen"]:::ui
        end
        subgraph "Other Screens"
            direction TB
            HOSC["HomeScreen"]:::ui
            HISSC["HistoryScreen"]:::ui
            PROSC["ProfileScreen"]:::ui
            SETSC["Settings"]:::ui
        end
    end

    click NAV "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/navigation/AppNavDisplay.kt"
    click AUTHNAV "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/navigation/AuthNavDisplay.kt"
    click SCRN "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/navigation/Screen.kt"
    click LSC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/authentication/login/LoginScreen.kt"
    click RSC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/authentication/register/RegisterScreen.kt"
    click HOSC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/home/HomeScreen.kt"
    click HISSC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/history/HistoryScreen.kt"
    click PROSC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/profile/ProfileScreen.kt"
    click SETSC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/settings/Settings.kt"

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        LVM["LoginViewModel"]:::vm
        RVM["RegisterViewModel"]:::vm
        HOVM["HistoryViewModel"]:::vm
        PRVM["ProfileViewModel"]:::vm
        SEVM["SettingsViewModel"]:::vm
    end

    click LVM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/authentication/login/LoginViewModel.kt"
    click RVM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/authentication/register/RegisterViewModel.kt"
    click HOVM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/history/HistoryViewModel.kt"
    click PRVM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/profile/ProfileViewModel.kt"
    click SEVM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/screens/settings/SettingsViewModel.kt"

    %% Domain Layer
    subgraph "Domain Layer"
        UC["GetUserUseCase"]:::domain
        subgraph "Models"
            direction TB
            UM["User"]:::domain
            ARM["AuthResult"]:::domain
            STM["SupportedThemes"]:::domain
        end
        subgraph "Repositories Interfaces"
            direction TB
            ARI["AuthRepository"]:::domain
            APR["AppPreferences"]:::domain
            DSP["DataStorePreference"]:::domain
        end
    end

    click UC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/domain/usecase/GetUserUseCase.kt"
    click UM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/domain/model/User.kt"
    click ARM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/domain/model/AuthResult.kt"
    click STM "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/domain/model/SupportedThemes.kt"
    click ARI "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/domain/repository/AuthRepository.kt"
    click APR "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/domain/repository/appPreferences/AppPreferences.kt"
    click DSP "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/domain/repository/appPreferences/DataStorePreference.kt"

    %% Data Layer
    subgraph "Data Layer"
        subgraph "Firebase DataSources"
            FSVC["FirebaseServices"]:::data
            GSC["GoogleSignClient"]:::data
        end
        subgraph "Repository Impl"
            AUTHIMP["AuthRepositoryImpl"]:::data
        end
        subgraph "Local DataSources"
            DB["AppDatabase"]:::data
            PREFIMP["AppPreferencesImpl"]:::data
        end
    end

    click FSVC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/data/firebase/auth/FirebaseServices.kt"
    click GSC "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/data/firebase/auth/GoogleSignClient.kt"
    click AUTHIMP "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/data/repository/AuthRepositoryImpl.kt"
    click DB "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/data/local/AppDatabase.kt"
    click PREFIMP "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/data/local/AppPreferencesImpl.kt"

    %% UI Components & Theme
    subgraph "UI Components & Theme"
        direction TB
        COMP["Components"]:::ui
        THEME["Theme"]:::ui
    end
    click COMP "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/components/BottomNavigation.kt"
    click THEME "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/ui/theme/Theme.kt"

    subgraph "Utilities"
        CONS["Constants"]:::data
        RES["Resource"]:::data
        VAL["Validator"]:::data
        EXT["Extensions"]:::data
        DT["DateUtils"]:::data
    end
    click CONS "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/utils/Constants.kt"
    click RES "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/utils/Resource.kt"
    click VAL "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/utils/Validator.kt"
    click EXT "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/utils/Extensions.kt"
    click DT "https://github.com/bsoc-bitbyte/digigate/blob/main/app/src/main/java/com/tpc/digigate/utils/DateUtils.kt"

    %% External Services
    subgraph "External Firebase Services"
        direction TB
        FA["Firebase Auth"]:::external
        FF["Firestore"]:::external
        FS["Storage"]:::external
    end

    %% Relationships
    NAV --> LSC
    NAV --> RSC
    NAV --> HOSC
    NAV --> HISSC
    NAV --> PROSC
    NAV --> SETSC

    LSC --> LVM
    RSC --> RVM
    HISSC --> HOVM
    PROSC --> PRVM
    SETSC --> SEVM

    LVM --> UC
    RVM --> UC
    HOVM --> UC
    PRVM --> UC
    SEVM --> UC

    UC --> ARI
    UC --> APR
    UC --> DSP

    ARI --> AUTHIMP
    APR --> PREFIMP
    DSP --> PREFIMP

    AUTHIMP --> FSVC
    AUTHIMP --> GSC
    AUTHIMP --> DB
    FSVC --> FA
    FSVC --> FF
    GSC --> FA

    DB --> DT
    PREFIMP --> RES

    FF --> HOVM
    FF --> PROSC
    FF --> LVM

    %% Styles
    classDef ui fill:#e0f7fa,stroke:#006064
    classDef vm fill:#bbdefb,stroke:#0d47a1
    classDef domain fill:#ffe0b2,stroke:#e65100
    classDef data fill:#c8e6c9,stroke:#2e7d32
    classDef external fill:#ffccbc,stroke:#bf360c
```
