# danilkinkin/buckwheat architecture

> Architecture diagram of the GitHub repository danilkinkin/buckwheat, 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/danilkinkin/buckwheat
- Repository: https://github.com/danilkinkin/buckwheat

## Overview

##### Project type and purpose
- This is a single-module Android mobile application (“Buckwheat”) for tracking and budgeting personal or travel spending.
- It’s built with Kotlin, Jetpack Compose (UI packages like `home`, `history`, `analytics`, etc.), Room for persistence, and a simple DI setup (packages under `di`).

##### File structure
- Top-level: Gradle/Kotlin DSL build files, Fastlane for CI/CD, Crowdin config for localization, screenshots, policy/license.
- `app/`: the only Android module, with:
- `src/main/java/com/danilkinkin/buckwheat/...` — all code subdivided by feature (UI, analytics, editor, history, wallet, settings, widget, util, effects, etc.)
- `src/main/res/` — layouts, drawables, themes, multilingual resources.
- `src/androidTest/` — end-to-end tests with fake DI components.
- `schemas/` — JSON schemas for the DI DatabaseModule (Room).
- Key architectural clues:
- MVVM pattern (ViewModels in `data`, `editor`, `recalcBudget`, etc.)
- Clean separation: UI packages → ViewModel → Repository/UseCases (`di` + `data/dao` + `data/entities`) → Room Database
- External flows: Crash reporting (`CatchAndSendCrashReport`), Analytics (`analytics` package), App Widgets (`widget` packages)

##### Extract architecture cues from README
- No server-side component—fully on-device.
- Localization via Crowdin.
- Distribution via Google Play, F-Droid, IzzyOnDroid (handled in Fastlane metadata).

##### Diagramming recommendations
– Group related components in containers (e.g., “app/src/main/java/com/danilkinkin/buckwheat” as one module)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        A1["Analytics Screens"]:::ui
        A2["Editor Screens"]:::ui
        A3["History Screens"]:::ui
        A4["Home Screen"]:::ui
        A5["Onboarding Screens"]:::ui
        A6["Wallet Screens"]:::ui
        A7["Settings Screens"]:::ui
        A8["Keyboard Component"]:::ui
        A9["Recalculate Budget Screens"]:::ui
        A10["Widget (Minimal)"]:::ui
        A11["Widget (Extended)"]:::ui
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        VM1["AppViewModel"]:::vm
        VM2["SpendsViewModel"]:::vm
        VM3["EditorViewModel"]:::vm
        VM4["RecalcBudgetViewModel"]:::vm
        VM5["KeyboardViewModel"]:::vm
        VM6["RestBudgetPillViewModel"]:::vm
    end

    %% Domain Layer
    subgraph "Domain Layer"
        D1["GetCurrentDateUseCase"]:::domain
        D2["SettingsRepository"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        R1["SpendsRepository"]:::data
        D3["StorageDao"]:::data
        D4["TransactionDao"]:::data
        E1["Storage Entity"]:::data
        E2["Transaction Entity"]:::data
        DB["Room Database"]:::data
    end

    %% DI Layer
    subgraph "Dependency Injection"
        DI1["AppModule"]:::di
        DI2["DatabaseModule"]:::di
        DI3["RoomConverters"]:::di
        DI4["Migration Helper"]:::di
    end

    %% External Services
    subgraph "External Services"
        EX1["Crash Reporting"]:::ext
        EX2["Analytics Integration"]:::ext
    end

    %% Build/Distribution Pipeline
    subgraph "Build & Distribution"
        B1["Crowdin (Localization)"]:::build
        B2["Fastlane CI/CD"]:::build
        B3["App Stores"]:::build
    end

    %% Relationships
    A1 -->|state| VM1
    A2 -->|state| VM3
    A3 -->|state| VM2
    A4 -->|state| VM1
    A5 -->|state| VM1
    A6 -->|state| VM2
    A7 -->|state| VM1
    A8 -->|state| VM5
    A9 -->|state| VM4
    A10 -->|state| VM1
    A11 -->|state| VM1

    VM1 -->|uses| D1
    VM1 -->|uses| D2
    VM2 -->|uses| D2
    VM3 -->|uses| D2
    VM4 -->|uses| D1
    VM5 -->|uses| D1
    VM6 -->|uses| D1

    D1 -->|calls| R1
    D2 -->|calls| R1

    R1 -->|reads/writes| D3
    R1 -->|reads/writes| D4
    D3 -->|maps| E1
    D4 -->|maps| E2
    D3 -->|stores| DB
    D4 -->|stores| DB

    DI1 -->|injects| VM1
    DI1 -->|injects| VM2
    DI2 -->|provides| DB
    DI2 -->|injects| R1
    DI3 -->|used by| DI2
    DI4 -->|used by| DI2

    VM1 -->|reports| EX1
    VM1 -->|reports| EX2
    VM2 -->|reports| EX2
    VM3 -->|reports| EX2

    B1 -->|provides| Crowdin
    B2 -->|builds| A4
    B2 -->|deploys| B3

    %% Click Events
    click A1 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/analytics"
    click A2 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/editor"
    click A3 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/history"
    click A4 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/home/MainScreen.kt"
    click A5 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/onboarding"
    click A6 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/wallet"
    click A7 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/settings"
    click A8 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/keyboard"
    click A9 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/recalcBudget"
    click A10 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/widget/minimal"
    click A11 "https://github.com/danilkinkin/buckwheat/tree/master/app/src/main/java/com/danilkinkin/buckwheat/widget/extend"
    click VM1 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/data/AppViewModel.kt"
    click VM2 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/data/SpendsViewModel.kt"
    click VM3 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/editor/EditorViewModel.kt"
    click VM4 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/recalcBudget/RecalcBudgetViewModel.kt"
    click VM5 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/keyboard/KeyboardViewModel.kt"
    click VM6 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/editor/toolbar/restBudgetPill/RestBudgetPillViewModel.kt"
    click D1 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/di/GetCurrentDateUseCase.kt"
    click D2 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/di/SettingsRepository.kt"
    click R1 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/di/SpendsRepository.kt"
    click D3 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/data/dao/StorageDao.kt"
    click D4 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/data/dao/TransactionDao.kt"
    click DI1 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/di/AppModule.kt"
    click DI2 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/di/DatabaseModule.kt"
    click DI3 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/di/RoomConverters.kt"
    click DI4 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/di/migrateToDataStore.kt"
    click EX1 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/CatchAndSendCrashReport.kt"
    click EX2 "https://github.com/danilkinkin/buckwheat/blob/master/app/src/main/java/com/danilkinkin/buckwheat/analytics/Analytics.kt"
    click B1 "https://github.com/danilkinkin/buckwheat/blob/master/crowdin.yml"
    click B2 "https://github.com/danilkinkin/buckwheat/tree/master/fastlane"
    click B3 "https://github.com/danilkinkin/buckwheat/tree/master/fastlane/metadata"

    %% Styles
    classDef ui fill:#D0E7FF,stroke:#0366D6,color:#0366D6;
    classDef vm fill:#E2F7E1,stroke:#228B22,color:#228B22;
    classDef domain fill:#E8F4D9,stroke:#6B8E23,color:#6B8E23;
    classDef data fill:#FFF4CC,stroke:#CD950C,color:#CD950C;
    classDef di fill:#FDEBD0,stroke:#E67E22,color:#D35400;
    classDef ext fill:#FFE4E1,stroke:#FF4500,color:#FF0000;
    classDef build fill:#F0F0F0,stroke:#A9A9A9,color:#696969;
```
