# mrihsann/expense-tracking-app architecture

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

- Interactive diagram: https://gitdiagram.com/mrihsann/expense-tracking-app
- Repository: https://github.com/mrihsann/expense-tracking-app

## Overview

##### Project type and purpose
- This is a single-module Android application (“Expense Tracking App”) built with Kotlin and Jetpack Compose
- It follows a Clean Architecture / MVVM pattern for tracking user expenses and handling authentication

##### High-level architectural layers
- Presentation Layer
– Composable Screens (AuthScreen, HomeScreen, ListScreen, AddScreen, SettingsScreen, TrackingScreen)
– ViewModels (AuthViewModel, HomeViewModel, ListViewModel, AddViewModel, SettingsViewModel)
– NavigationGraph & Screen sealed class
- Domain Layer
– Use Cases (SignIn, SignUp, SignOut, CurrentUser)
– Repository Interfaces (IFirebaseAuth)
– Domain Models (Expense, ExpenseCategory)
- Data Layer
– Repository Implementations (FirebaseAuthImpl)
– Local Data Source (AppDataStore using Android DataStore)
– Remote Data Source (Firebase Auth service)
– DI Modules (FirebaseModule, LocalStorageModule, RepositoryModule, UseCaseModule)

##### External components
– Firebase Authentication (external cloud service)
– Android DataStore (local key-value persistence)

##### Relationships and data flows
UI (Compose Screens) → ViewModels
ViewModels → Use Cases (domain)
Use Cases → Repository Interfaces
Repository Interfaces → Implementations (data)
- FirebaseAuthImpl → Firebase Auth
- AppDataStore → DataStore
Any asynchronous or callback responses flow back up the same path in reverse

##### Key architectural patterns
– MVVM (ViewModel mediates between UI and domain)
– Clean Architecture layering for testability and separation of concerns
– Dependency Injection (modules register interfaces to implementations)
– Jetpack Compose for UI, Android Navigation for routing

[ ] DI modules and bindings explicitly shown

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        AuthScreen["AuthScreen"]:::presentation
        LoginScreen["LoginScreen"]:::presentation
        RegisterScreen["RegisterScreen"]:::presentation
        HomeScreen["HomeScreen"]:::presentation
        ListScreen["ListScreen"]:::presentation
        AddScreen["AddScreen"]:::presentation
        SettingsScreen["SettingsScreen"]:::presentation
        TrackingScreen["TrackingScreen"]:::presentation
        AuthViewModel["AuthViewModel"]:::presentation
        HomeViewModel["HomeViewModel"]:::presentation
        ListViewModel["ListViewModel"]:::presentation
        AddViewModel["AddViewModel"]:::presentation
        SettingsViewModel["SettingsViewModel"]:::presentation
        NavigationGraph["NavigationGraph"]:::presentation
        Screen["Screen (sealed)"]:::presentation
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        SignInUseCase["SignInWithEmailAndPasswordUseCase"]:::domain
        SignUpUseCase["SignUpWithEmailAndPasswordUseCase"]:::domain
        SignOutUseCase["SignOutUseCase"]:::domain
        CurrentUserUseCase["CurrentUserUseCase"]:::domain
        IFirebaseAuth["IFirebaseAuth"]:::domain
        Expense["Expense"]:::domain
        ExpenseCategory["ExpenseCategory"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        FirebaseAuthImpl["FirebaseAuthImpl"]:::data
        AppDataStore["AppDataStore"]:::data
        FirebaseModule["FirebaseModule"]:::data
        LocalStorageModule["LocalStorageModule"]:::data
        RepositoryModule["RepositoryModule"]:::data
        UseCaseModule["UseCaseModule"]:::data
    end

    %% External Services
    FirebaseAuthService[(Firebase Auth)]:::external
    DataStore[(Android DataStore)]:::external

    %% Presentation to Domain
    AuthScreen -->|"interacts with"| AuthViewModel
    LoginScreen -->|"interacts with"| AuthViewModel
    RegisterScreen -->|"interacts with"| AuthViewModel
    HomeScreen -->|"interacts with"| HomeViewModel
    ListScreen -->|"interacts with"| ListViewModel
    AddScreen -->|"interacts with"| AddViewModel
    SettingsScreen -->|"interacts with"| SettingsViewModel
    TrackingScreen -->|"interacts with"| HomeViewModel
    NavigationGraph -->|"routes to"| AuthScreen
    NavigationGraph -->|"routes to"| HomeScreen
    NavigationGraph -->|"routes to"| ListScreen
    NavigationGraph -->|"routes to"| AddScreen
    NavigationGraph -->|"routes to"| SettingsScreen
    NavigationGraph -->|"routes to"| TrackingScreen
    Screen -->|"defines screens"| NavigationGraph

    AuthViewModel -->|"invoke useCase()"| SignInUseCase
    AuthViewModel -->|"invoke useCase()"| SignUpUseCase
    AuthViewModel -->|"invoke useCase()"| SignOutUseCase
    AuthViewModel -->|"invoke useCase()"| CurrentUserUseCase
    HomeViewModel -->|"invoke useCase()"| CurrentUserUseCase
    ListViewModel -->|"invoke useCase()"| CurrentUserUseCase
    AddViewModel -->|"invoke useCase()"| CurrentUserUseCase
    SettingsViewModel -->|"invoke useCase()"| SignOutUseCase

    SignInUseCase -->|"depends on"| IFirebaseAuth
    SignUpUseCase -->|"depends on"| IFirebaseAuth
    SignOutUseCase -->|"depends on"| IFirebaseAuth
    CurrentUserUseCase -->|"depends on"| IFirebaseAuth

    %% DI Modules
    FirebaseModule -->|"provides"| FirebaseAuthImpl
    LocalStorageModule -->|"provides"| AppDataStore
    RepositoryModule -->|"binds IFirebaseAuth to"| FirebaseAuthImpl
    UseCaseModule -->|"provides"| SignInUseCase
    UseCaseModule -->|"provides"| SignUpUseCase
    UseCaseModule -->|"provides"| SignOutUseCase
    UseCaseModule -->|"provides"| CurrentUserUseCase

    %% Data to External
    FirebaseAuthImpl -->|"authenticate user"| FirebaseAuthService
    AppDataStore -->|"read/write"| DataStore

    %% Return flows
    FirebaseAuthService -.->|"auth response"| FirebaseAuthImpl
    DataStore -.->|"data response"| AppDataStore
    FirebaseAuthImpl -.->|"result"| IFirebaseAuth
    AppDataStore -.->|"stored data"| IFirebaseAuth

    %% Click Events
    click AuthScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/auth/AuthScreen.kt"
    click LoginScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/auth/LoginScreen.kt"
    click RegisterScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/auth/RegisterScreen.kt"
    click HomeScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/home/HomeScreen.kt"
    click ListScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/list/ListScreen.kt"
    click AddScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/add/AddScreen.kt"
    click SettingsScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/settings/SettingsScreen.kt"
    click TrackingScreen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/tracking/TrackingScreen.kt"
    click AuthViewModel "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/auth/AuthViewModel.kt"
    click HomeViewModel "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/home/HomeViewModel.kt"
    click ListViewModel "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/list/ListViewModel.kt"
    click AddViewModel "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/add/AddViewModel.kt"
    click SettingsViewModel "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/presentation/settings/SettingsViewModel.kt"
    click NavigationGraph "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/navigation/NavigationGraph.kt"
    click Screen "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/navigation/Screen.kt"
    click CurrentUserUseCase "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/domain/usecase/CurrentUserUseCase.kt"
    click SignInUseCase "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/domain/usecase/SignInWithEmailAndPasswordUseCase.kt"
    click SignOutUseCase "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/domain/usecase/SignOutUseCase.kt"
    click SignUpUseCase "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/domain/usecase/SignUpWithEmailAndPasswordUseCase.kt"
    click IFirebaseAuth "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/domain/repository/IFirebaseAuth.kt"
    click Expense "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/domain/model/Expense.kt"
    click ExpenseCategory "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/domain/model/ExpenseCategory.kt"
    click FirebaseAuthImpl "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/data/remote/repository/FirebaseAuthImpl.kt"
    click AppDataStore "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/data/local/AppDataStore.kt"
    click FirebaseModule "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/di/FirebaseModule.kt"
    click LocalStorageModule "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/di/LocalStorageModule.kt"
    click RepositoryModule "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/di/RepositoryModule.kt"
    click UseCaseModule "https://github.com/mrihsann/expense-tracking-app/blob/master/app/src/main/java/com/ihsanarslan/expensetrackingapp/di/UseCaseModule.kt"

    %% Styles
    classDef presentation fill:#D0E8FF,stroke:#005B96,color:#000;
    classDef domain fill:#D1E8D1,stroke:#2E7D32,color:#000;
    classDef data fill:#FFE0B2,stroke:#EF6C00,color:#000;
    classDef external fill:#E0E0E0,stroke:#757575,color:#000;
```
