# bsoc-bitbyte/nudj architecture

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

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

## Overview

##### Project Type and Purpose
- This is a full-stack Android mobile application (“Nudj”) built with Kotlin and Jetpack Compose on the client side, using Firebase services for its backend.
- Hosts list and manage events; students browse, RSVP, and receive notifications.

##### High-level Architecture Components
a. Presentation Layer (Android App)
- UI (Jetpack Compose screens & components)
- Navigation (Compose Navigation in Screens.kt)
b. Application Layer
- ViewModels (BaseViewModel, per-screen ViewModels in ui/screens/*)
- UI State Classes (e.g., LoginUiState, ForgotPasswordUIState)
c. Domain/Data Layer
- Repositories (AuthRepository, FirebaseRepository, GoogleSignInClient)
- Models (User.kt, AuthResult.kt)
d. Dependency Injection
- Hilt or custom DI module (AuthModule.kt)
- Application class (NudjApplication.kt)
e. External Services
- Firebase Auth
- Firestore / Realtime Database (for event data)
- FCM (notifications)
- Google Sign-In

##### Relationships & Data Flows
- UI <–> ViewModel: Compose UI emits user actions; ViewModel exposes UIState via LiveData/StateFlow.
- ViewModel <–> Repository: ViewModels invoke repository methods for auth and data operations.
- Repository <–> Firebase Services: Repository delegates to Firebase SDK (Auth, Firestore, FCM).
- DI Container wires ViewModels to Repositories and SDK clients (GoogleSignInClient).

##### Architectural Patterns & Principles
- MVVM (Model-View-ViewModel)
- Single Activity (MainActivity) + Compose Navigation
- Clean separation of concerns: UI, state, domain logic, infrastructure
- Dependency Injection for testability and modularity

##### Detailed Steps for the Engineer
a. A large rectangle titled “Android App (com.tpc.nudj)”.
b. Inside, partition into horizontal layers:
1) Presentation: List key files/packages (ui/components, ui/screens, navigation)
2) ViewModel: BaseViewModel + each screen’s ViewModel
3) Data/Repository: AuthRepository, FirebaseRepository, GoogleSignInClient
4) DI: AuthModule, NudjApplication
- ViewModel → AuthRepository → Firebase Auth
- ViewModel → FirebaseRepository → Firestore
- FirebaseAuth events → AuthRepository → ViewModel
- FCM → Mobile OS → ViewModel → UI
e. Technologies alongside each component (e.g., “Jetpack Compose,” “StateFlow,” “Kotlin”).
f. Optionally, add a “Google OAuth” bubble linked to GoogleSignInClient.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Android App (com.tpc.nudj)"
        subgraph "Presentation Layer"
            UIComp["UI Components\n(Jetpack Compose)"]:::client
            ScreensComp["Compose Screens"]:::client
            Nav["Navigation\n(Screens.kt)"]:::client
            Theme["Theme\n(Color.kt, Theme.kt, Type.kt)"]:::client
        end
        subgraph "ViewModel Layer"
            BaseVM["BaseViewModel"]:::client
            LoginVM["LoginViewModel"]:::client
            SignUpVM["SignUpViewModel"]:::client
            ForgotVM["ForgotPasswordViewModel"]:::client
            DetailVM["UserDetailViewModel"]:::client
            DashVM["DashBoardViewModel"]:::client
        end
        subgraph "Data/Repository Layer"
            AuthRepo["AuthRepository"]:::repo
            FirebaseRepo["FirebaseRepository"]:::repo
            GoogleClient["GoogleSignInClient"]:::repo
            UserModel["User"]:::model
            AuthResultModel["AuthResult"]:::model
        end
        subgraph "Dependency Injection"
            AuthMod["AuthModule"]:::di
            AppClass["NudjApplication"]:::di
            MainAct["MainActivity"]:::client
        end
    end

    subgraph "External Services"
        FirebaseAuth["Firebase Auth"]:::ext
        Firestore["Firestore"]:::ext
        FCM["FCM (Cloud Messaging)"]:::ext
        GoogleOAuth["Google OAuth"]:::ext
    end

    UIComp -->|"user actions"| BaseVM
    ScreensComp -->|navigation events| BaseVM
    Nav -->|navigates to| ScreensComp
    Theme -->|applies theme| UIComp

    BaseVM -->|calls| AuthRepo
    BaseVM -->|calls| FirebaseRepo

    AuthRepo -->|uses| FirebaseAuth
    FirebaseRepo -->|uses| Firestore
    GoogleClient -->|auth via| GoogleOAuth

    FirebaseAuth -->|auth status| AuthRepo
    Firestore -->|data| FirebaseRepo

    FCM -->|push notifications| BaseVM
    FCM -->|"async event"| UIComp

    AuthMod -->|provides| AuthRepo
    AuthMod -->|provides| FirebaseRepo
    AuthMod -->|provides| GoogleClient
    AppClass -->|initializes DI| AuthMod
    MainAct -->|hosts UI| UIComp

    click UIComp "https://github.com/bsoc-bitbyte/nudj/tree/main/app/src/main/java/com/tpc/nudj/ui/components"
    click ScreensComp "https://github.com/bsoc-bitbyte/nudj/tree/main/app/src/main/java/com/tpc/nudj/ui/screens"
    click Nav "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/navigation/Screens.kt"
    click Theme "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/theme/Color.kt"
    click Theme "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/theme/Theme.kt"
    click Theme "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/theme/Type.kt"
    click BaseVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/BaseViewModel.kt"
    click LoginVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/login/LoginViewModel.kt"
    click SignUpVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/signup/SignUpViewModel.kt"
    click ForgotVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/forgotPassword/ForgotPasswordViewModel.kt"
    click DetailVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/detailsInput/UserDetailViewModel.kt"
    click DashVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/dashboard/DashBoardViewModel.kt"
    click LoginVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/login/LoginUiState.kt"
    click SignUpVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/signup/SignUpUiState.kt"
    click ForgotVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/forgotPassword/ForgotPasswordUIState.kt"
    click DetailVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/auth/detailsInput/UserDetailsUIState.kt"
    click DashVM "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/ui/screens/dashboard/DashBoardUiState.kt"
    click UserModel "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/model/User.kt"
    click AuthResultModel "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/model/AuthResult.kt"
    click AuthRepo "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/repository/auth/AuthRepository.kt"
    click FirebaseRepo "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/repository/auth/FirebaseRepository.kt"
    click GoogleClient "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/repository/auth/GoogleSignInClient.kt"
    click AuthMod "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/di/AuthModule.kt"
    click AppClass "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/application/NudjApplication.kt"
    click MainAct "https://github.com/bsoc-bitbyte/nudj/blob/main/app/src/main/java/com/tpc/nudj/MainActivity.kt"

    classDef client fill:#EEF6FF,stroke:#0366D6,color:#0366D6
    classDef repo fill:#E6FFEF,stroke:#28A745,color:#28A745
    classDef model fill:#FFF5E6,stroke:#D97706,color:#D97706
    classDef di fill:#F0F0F0,stroke:#A0A0A0,color:#000000
    classDef ext fill:#FFF0E6,stroke:#FF8C00,color:#FF8C00
```
