# jouwdan/todo architecture

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

- Interactive diagram: https://gitdiagram.com/jouwdan/todo
- Repository: https://github.com/jouwdan/todo

## Overview

##### Project type and purpose
- This is a native Android mobile application (“Todo”) written in Kotlin.
- It follows MVVM and Clean Architecture principles, uses Jetpack Fragments & Navigation, Hilt for DI, and Firebase (Authentication + Firestore) as its backend.

##### File structure
- Top-level “app” module contains all source code.
- “src/main/java/dev/jord/todo” subdivides into:
- data/model (Task, User)
- data/repository (interface + implementation)
- di (Hilt modules: AppModule, FirebaseModule, RepositoryModule)
- ui (Fragments split into auth, home, account) + ViewModels + Adapters
- util (Constants, Extensions, UiState)
- Navigation XML files for auth & home flows
- Activities (LoginActivity, MainActivity) host the NavHostFragments
- Tests & Android instrumentation tests mirror source structure
- build scripts, ProGuard, manifest, resource layouts, drawables, themes

##### Insights from README
- Uses Firebase Auth & Firestore as its sole backend
- UI built on Material 3, adapts system theme
- Strong emphasis on MVVM / Clean Architecture
- Dependency injection via Dagger Hilt

##### Elements
- User actions → Fragment → ViewModel → Repository Interface → Repository Impl → Firebase
- Firebase responses → Repository Impl → ViewModel → Fragment
- ViewModels in another
- Repository interfaces & implementations in a third
- External services (Firebase) in a cloud symbol or different hue
- Navigation XMLs as part of UI layer
- Hilt Modules and where they inject dependencies

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Dependency Injection Layer
    subgraph "Dependency Injection (Hilt)"
        direction TB
        HiltApp["MyApplication"]:::di
        AppModule["AppModule"]:::di
        FirebaseModule["FirebaseModule"]:::di
        RepositoryModule["RepositoryModule"]:::di
    end

    %% UI Layer
    subgraph "UI Layer"
        direction TB
        LoginActivity["LoginActivity"]:::ui
        MainActivity["MainActivity"]:::ui

        subgraph "Auth Flow"
            direction TB
            WelcomeFrag["WelcomeFragment"]:::ui
            LoginFrag["LoginFragment"]:::ui
            RegisterFrag["RegisterFragment"]:::ui
            ForgotFrag["ForgotPasswordFragment"]:::ui
        end

        subgraph "Home Flow"
            direction TB
            HomeFrag["HomeFragment"]:::ui
            AddTaskFrag["AddTaskFragment"]:::ui
            TaskAdapter["TaskAdapter"]:::ui
        end

        AccountFrag["AccountFragment"]:::ui
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        AuthVM["AuthViewModel"]:::vm
        TaskVM["TaskViewModel"]:::vm
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        AuthRepoI["AuthRepository"]:::repo
        TaskRepoI["TaskRepository"]:::repo
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        AuthRepoImpl["AuthRepositoryImplementation"]:::impl
        TaskRepoImpl["TaskRepositoryImplementation"]:::impl
        UserModel["User"]:::model
        TaskModel["Task"]:::model
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        Constants["Constants"]:::util
        Extensions["Extensions"]:::util
        UiState["UiState"]:::util
    end

    %% External Services
    subgraph "External Services"
        direction TB
        FirebaseAuth["Firebase Authentication"]:::ext
        Firestore["Cloud Firestore"]:::ext
    end

    %% Connections
    LoginActivity -->|hosts| WelcomeFrag
    LoginActivity -->|hosts| LoginFrag
    MainActivity -->|hosts| HomeFrag
    MainActivity -->|hosts| AccountFrag

    WelcomeFrag -->|uses| AuthVM
    LoginFrag -->|uses| AuthVM
    RegisterFrag -->|uses| AuthVM
    ForgotFrag -->|uses| AuthVM

    HomeFrag -->|uses| TaskVM
    AddTaskFrag -->|uses| TaskVM
    TaskAdapter -->|binds| HomeFrag

    AccountFrag -->|reads| AuthVM

    AuthVM -->|depends on| AuthRepoI
    TaskVM -->|depends on| TaskRepoI

    AuthRepoI -->|implemented by| AuthRepoImpl
    TaskRepoI -->|implemented by| TaskRepoImpl

    AuthRepoImpl -->|calls| FirebaseAuth
    AuthRepoImpl -->|calls| Firestore
    TaskRepoImpl -->|calls| Firestore

    HiltApp -->|initializes| AppModule
    HiltApp -->|initializes| FirebaseModule
    HiltApp -->|initializes| RepositoryModule

    AppModule -->|provides| Constants
    AppModule -->|provides| Extensions
    AppModule -->|provides| UiState

    FirebaseModule -->|provides| FirebaseAuth
    FirebaseModule -->|provides| Firestore

    RepositoryModule -->|binds| AuthRepoI
    RepositoryModule -->|binds| TaskRepoI
    RepositoryModule -->|binds| AuthRepoImpl
    RepositoryModule -->|binds| TaskRepoImpl

    %% Click Events
    click HiltApp "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/MyApplication.kt"
    click LoginActivity "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/LoginActivity.kt"
    click MainActivity "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/MainActivity.kt"
    click WelcomeFrag "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/auth/WelcomeFragment.kt"
    click LoginFrag "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/auth/LoginFragment.kt"
    click RegisterFrag "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/auth/RegisterFragment.kt"
    click ForgotFrag "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/auth/ForgotPasswordFragment.kt"
    click HomeFrag "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/home/HomeFragment.kt"
    click AddTaskFrag "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/home/AddTaskFragment.kt"
    click TaskAdapter "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/home/TaskAdapter.kt"
    click AccountFrag "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/account/AccountFragment.kt"
    click AuthVM "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/auth/AuthViewModel.kt"
    click TaskVM "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/ui/home/TaskViewModel.kt"
    click AuthRepoI "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/data/repository/AuthRepository.kt"
    click TaskRepoI "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/data/repository/TaskRepository.kt"
    click AuthRepoImpl "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/data/repository/AuthRepositoryImplementation.kt"
    click TaskRepoImpl "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/data/repository/TaskRepositoryImplementation.kt"
    click UserModel "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/data/model/User.kt"
    click TaskModel "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/data/model/Task.kt"
    click AppModule "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/di/AppModule.kt"
    click FirebaseModule "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/di/FirebaseModule.kt"
    click RepositoryModule "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/di/RepositoryModule.kt"
    click Constants "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/util/Constants.kt"
    click Extensions "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/util/Extensions.kt"
    click UiState "https://github.com/jouwdan/todo/blob/main/app/src/main/java/dev/jord/todo/util/UiState.kt"

    %% Styles
    classDef ui fill:#E3F2FD,stroke:#90CAF9
    classDef vm fill:#BBDEFB,stroke:#64B5F6
    classDef repo fill:#C8E6C9,stroke:#81C784
    classDef impl fill:#A5D6A7,stroke:#66BB6A
    classDef di fill:#FFF9C4,stroke:#FFF176
    classDef ext fill:#FFE0B2,stroke:#FFB74D
    classDef model fill:#F3E5F5,stroke:#CE93D8
    classDef util fill:#E1F5FE,stroke:#81D4FA
```
