# shub39/grit architecture

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

- Interactive diagram: https://gitdiagram.com/shub39/grit
- Repository: https://github.com/shub39/grit

## Overview

##### Project type and purpose
- This is a native Android mobile application (“Grit”) written in Kotlin.
- Purpose: a simple To-Do list and daily habit tracker featuring analytics, notifications, widgets, and backup/restore.

##### File structure
- Top-level:
- app/ – the single Android application module
- build scripts (Gradle, fastlane, CI workflows)
- app/src/main/java/com/shub39/grit: follows a clean-architecture style, divided into:
- app/ – Application & Activity entrypoints + Navigation
- core/ – cross-cutting layers:
­ data/ (DataStore, notifications, backup)
­ domain/ (interfaces and models)
­ presentation/ (shared UI components and themes)
- di/ – dependency-injection modules (Koin or Hilt style)
- features:
­ habits/ (feature-specific data, domain, presentation)
­ tasks/ (same as above)
- viewmodels/ – MVVM ViewModel classes
- widgets/ – Android AppWidgets for home-screen display
- Persistence: Jetpack DataStore + Room databases (HabitDatabase, TaskDatabase).
- Receivers: BootReceiver, NotificationReceiver for scheduling via AlarmManager.
- Backup/Restore: ExportImpl / RestoreImpl under core/data/backup.

##### README for additional insights
- Confirms feature set: Todos, Habit tracking, analytics, notifications, widgets.
- No external servers or cloud backends—entirely on-device with optional backup export.

##### Elements
- Blue for UI/Presentation
- Green for Domain
- Orange for Data/Persistence
- Gray for Android System & external services

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Android System & External Services
    subgraph "Android System & Services"
        AlarmManager["AlarmManager"]:::system
        AppWidgetManager["AppWidgetManager"]:::system
        FileIO["File I/O"]:::system
    end

    %% Application Layer
    subgraph "Application Layer"
        GritApp["GritApp"]:::app
        MainActivity["MainActivity"]:::app
        MainRoutes["Navigation Graph"]:::app
    end

    %% Dependency Injection
    GritModules["GritModules (DI Container)"]:::di

    %% Presentation Layer
    subgraph "Presentation Layer"
        UIComponents["Shared UI Components"]:::ui
        Themes["Shared Themes UI"]:::ui
        SettingsUI["Settings UI"]:::ui
        HabitsUI["Habits Feature UI"]:::ui
        TasksUI["Tasks Feature UI"]:::ui
        Widgets["Widgets (Home-Screen)"]:::ui
    end

    %% ViewModels
    subgraph "ViewModels"
        MainVM["MainViewModel"]:::vm
        HabitVM["HabitViewModel"]:::vm
        TasksVM["TasksViewModel"]:::vm
        SettingsVM["SettingsViewModel"]:::vm
    end

    %% Domain Layer
    subgraph "Domain Layer"
        CoreInterfaces["Core Interfaces & Models"]:::domain
        BackupInterfaces["Backup Interfaces"]:::domain
        HabitsDomain["Habits Domain Interfaces & Models"]:::domain
        TasksDomain["Tasks Domain Interfaces & Models"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        DataStoreImpl["DataStore Implementation"]:::data
        RoomDB["Room Databases"]:::data
        NotificationScheduler["NotificationAlarmScheduler"]:::data
        Receivers["BootReceiver & NotificationReceiver"]:::data
        BackupImpl["Backup & Restore Implementations"]:::data
    end

    %% Relationships
    AlarmManager -->|"schedules alarms"| NotificationScheduler
    NotificationScheduler -->|triggers| Receivers
    FileIO -->|read/write backup files| BackupImpl
    AppWidgetManager -->|updates widgets| Widgets

    GritApp --> MainActivity
    MainActivity --> MainRoutes

    MainRoutes -->|navigates to screens| HabitsUI
    MainRoutes -->|navigates to screens| TasksUI
    MainRoutes -->|navigates to screens| SettingsUI

    GritModules --> DataStoreImpl
    GritModules --> RoomDB
    GritModules --> NotificationScheduler
    GritModules --> BackupImpl
    GritModules --> HabitsDomain
    GritModules --> TasksDomain
    GritModules --> CoreInterfaces
    GritModules --> BackupInterfaces

    UIComponents -->|renders UI| MainVM
    Themes -->|applies styles| MainVM
    SettingsUI -->|renders settings| SettingsVM
    HabitsUI -->|renders habits| HabitVM
    TasksUI -->|renders tasks| TasksVM
    Widgets -->|binds data via| MainVM

    MainVM -->|invokes| CoreInterfaces
    SettingsVM -->|invokes| BackupInterfaces
    HabitVM -->|invokes| HabitsDomain
    TasksVM -->|invokes| TasksDomain

    CoreInterfaces -->|uses| DataStoreImpl
    HabitsDomain -->|uses| RoomDB
    TasksDomain -->|uses| RoomDB
    BackupInterfaces -->|uses| BackupImpl

    %% Click Events
    click GritApp "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/app/GritApp.kt"
    click MainActivity "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/app/MainActivity.kt"
    click MainRoutes "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/app/MainRoutes.kt"
    click GritModules "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/di/GritModules.kt"
    click UIComponents "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/core/presentation/components/"
    click Themes "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/core/presentation/theme/"
    click SettingsUI "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/core/presentation/settings/"
    click HabitsUI "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/habits/presentation/"
    click TasksUI "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/tasks/presentation/"
    click MainVM "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/viewmodels/"
    click CoreInterfaces "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/core/domain/"
    click BackupInterfaces "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/domain/backup/ExportRepo.kt"
    click HabitsDomain "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/habits/domain/"
    click TasksDomain "https://github.com/shub39/grit/tree/master/app/src/main/java/com/shub39/grit/tasks/domain/"
    click DataStoreImpl "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/data/DataStoreFactory.kt"
    click DataStoreImpl "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/data/DataStoreImpl.kt"
    click RoomDB "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/habits/data/database/HabitDatabase.kt"
    click NotificationScheduler "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/data/NotificationAlarmScheduler.kt"
    click Receivers "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/data/BootReceiver.kt"
    click Receivers "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/data/NotificationReceiver.kt"
    click BackupImpl "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/data/backup/export/ExportImpl.kt"
    click BackupImpl "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/core/data/backup/restore/RestoreImpl.kt"
    click Widgets "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/widgets/HabitOverviewWidget.kt"
    click Widgets "https://github.com/shub39/grit/blob/master/app/src/main/java/com/shub39/grit/widgets/HabitStreakWidget.kt"

    %% Styles
    classDef system fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef app fill:#B0C4DE,stroke:#333,stroke-width:1px
    classDef di fill:#CCCCFF,stroke:#333,stroke-width:1px
    classDef ui fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef vm fill:#87CEFA,stroke:#333,stroke-width:1px
    classDef domain fill:#90EE90,stroke:#333,stroke-width:1px
    classDef data fill:#FFA500,stroke:#333,stroke-width:1px
```
