# kotlin-android-open-source/mvi-coroutines-flow architecture

> Architecture diagram of the GitHub repository kotlin-android-open-source/mvi-coroutines-flow, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kotlin-android-open-source/mvi-coroutines-flow
- Repository: https://github.com/kotlin-android-open-source/mvi-coroutines-flow

## Overview

##### Project type and purpose
- This is a multi-module Android application showcasing Clean Architecture with MVI (Model-View-Intent) built on Kotlin, Coroutines, Flow, and ArrowKt.
- It’s composed of:
- A top-level “app” module (the Android host)
- Core common modules (core-ui, core, mvi-base, mvi-testing, test-utils)
- Domain and data layers (domain, data)
- Feature modules (feature-main, feature-add, feature-search)
- Build support (buildSrc, Gradle wrappers)

##### File structure
- Top-level gradle files and settings.gradle.kts wire up all modules.
- “app” depends on all feature modules plus core-ui, data, domain, etc., and contains the AndroidManifest and resource overlays.
- “core” contains pure Kotlin utilities: EitherNes, dispatchers, mappers.
- “core-ui” holds reusable UI bindings and navigation abstractions.
- “domain” defines your UseCases and Repository interface.
- “data” provides the UserRepositoryImpl, Retrofit API service, mappers, and error models.
- “feature-*” modules implement MVVM/MVI presentation: Contract, ViewModel (VM), Module (DI), Activity or Adapter, layouts, tests.
- “mvi-base” supplies abstract Activity/VM/ViewState/Intent/Event classes.
- “mvi-testing” & “test-utils” offer test rules, fake dispatchers, base test classes.

##### README for additional insights
- Explains your MVI cycle: intent() → model() → view().
- Mentions Clean Architecture layering, ArrowKt for functional programming, and Koin DI (with an obsolete Dagger Hilt branch).
- Shows your CI badges, minimum API level, and sample screenshots.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        App["App Module"]:::presentation
        FM["Feature-Main Module"]:::presentation
        FA["Feature-Add Module"]:::presentation
        FS["Feature-Search Module"]:::presentation
        MVI["MVI Base Library"]:::presentation
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        Domain["Domain Module"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        DataMod["Data Module"]:::data
        UserApi["UserApiService"]:::external
        Mapper["Data ↔ Domain Mappers"]:::data
    end

    %% Core/Common
    subgraph "Core/Common"
        direction TB
        Core["Core Module"]:::core
        CoreUI["Core-UI Module"]:::core
        Testing["MVI Testing Module"]:::core
        TestUtils["Test Utils Module"]:::core
    end

    %% Build & Tooling
    subgraph "Build & Tooling"
        direction TB
        BuildSrc["buildSrc (Version Catalogs)"]:::core
        Gradle["Gradle Wrappers & Config"]:::core
    end

    %% External Services
    subgraph "External"
        direction TB
        API["User REST API"]:::external
    end

    %% Relationships
    App -->|hosts| FM
    App -->|hosts| FA
    App -->|hosts| FS
    FM -->|uses| MVI
    FA -->|uses| MVI
    FS -->|uses| MVI
    FM -->|calls UseCases| Domain
    FA -->|calls UseCases| Domain
    FS -->|calls UseCases| Domain
    Domain -->|interface→impl| DataMod
    DataMod -->|Retrofit→| UserApi
    UserApi -->|HTTP→| API
    DataMod -->|maps| Mapper
    Mapper -->|to Domain| Domain
    Core -->|provides| FM
    Core -->|provides| FA
    Core -->|provides| FS
    CoreUI -->|provides| FM
    CoreUI -->|provides| FA
    CoreUI -->|provides| FS
    Testing -->|supports tests| FM
    Testing -->|supports tests| FA
    Testing -->|supports tests| FS
    TestUtils -->|supports tests| Domain
    TestUtils -->|supports tests| DataMod

    %% Click Events
    click App "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/app/src/main/java/com/hoc/flowmvi/App.kt"
    click Core "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/core/src/main/java/com/hoc/flowmvi/core/EitherNes.kt"
    click Core "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/core/src/main/java/com/hoc/flowmvi/core/dispatchers/AppCoroutineDispatchers.kt"
    click Core "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/core/src/main/java/com/hoc/flowmvi/core/Mapper.kt"
    click CoreUI "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/core-ui/src/main/java/com/hoc/flowmvi/core_ui/FlowBinding.kt"
    click CoreUI "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/core-ui/src/main/java/com/hoc/flowmvi/core_ui/navigator/Navigator.kt"
    click MVI "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/mvi/mvi-base/src/main/java/com/hoc/flowmvi/mvi_base/AbstractMviActivity.kt"
    click MVI "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/mvi/mvi-base/src/main/java/com/hoc/flowmvi/mvi_base/MviIntent.kt"
    click MVI "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/mvi/mvi-base/src/main/java/com/hoc/flowmvi/mvi_base/MviViewModel.kt"
    click MVI "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/mvi/mvi-base/src/main/java/com/hoc/flowmvi/mvi_base/MviViewState.kt"
    click Testing "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/mvi/mvi-testing/src/main/java/com/hoc/flowmvi/mvi_testing/BaseMviViewModelTest.kt"
    click TestUtils "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/test-utils/src/main/java/com/hoc/flowmvi/test_utils/TestCoroutineDispatcherRule.kt"
    click TestUtils "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/test-utils/src/main/java/com/hoc/flowmvi/test_utils/TestAppCoroutineDispatchers.kt"
    click Domain "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/domain/src/main/java/com/hoc/flowmvi/domain/DomainModule.kt"
    click Domain "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/domain/src/main/java/com/hoc/flowmvi/domain/repository/UserRepository.kt"
    click DataMod "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/data/src/main/java/com/hoc/flowmvi/data/DataModule.kt"
    click DataMod "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/data/src/main/java/com/hoc/flowmvi/data/remote/UserApiService.kt"
    click DataMod "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/data/src/main/java/com/hoc/flowmvi/data/mapper/UserResponseToUserDomainMapper.kt"
    click FM "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-main/src/main/java/com/hoc/flowmvi/ui/main/MainActivity.kt"
    click FM "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-main/src/main/java/com/hoc/flowmvi/ui/main/MainVM.kt"
    click FM "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-main/src/main/java/com/hoc/flowmvi/ui/main/MainModule.kt"
    click FM "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-main/src/main/java/com/hoc/flowmvi/ui/main/MainContract.kt"
    click FA "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-add/src/main/java/com/hoc/flowmvi/ui/add/AddActivity.kt"
    click FA "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-add/src/main/java/com/hoc/flowmvi/ui/add/AddVM.kt"
    click FA "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-add/src/main/java/com/hoc/flowmvi/ui/add/AddModule.kt"
    click FA "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-add/src/main/java/com/hoc/flowmvi/ui/add/AddContract.kt"
    click FS "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-search/src/main/java/com/hoc/flowmvi/ui/search/SearchActivity.kt"
    click FS "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-search/src/main/java/com/hoc/flowmvi/ui/search/SearchVM.kt"
    click FS "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-search/src/main/java/com/hoc/flowmvi/ui/search/SearchModule.kt"
    click FS "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-search/src/main/java/com/hoc/flowmvi/ui/search/SearchContract.kt"
    click FS "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/feature-search/src/main/java/com/hoc/flowmvi/ui/search/SearchAdapter.kt"
    click BuildSrc "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/buildSrc/src/main/kotlin/libsVersionCatalog.kt"
    click BuildSrc "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/buildSrc/src/main/kotlin/deps.kt"
    click Gradle "https://github.com/kotlin-android-open-source/mvi-coroutines-flow/blob/master/settings.gradle.kts"

    %% Styles
    classDef presentation fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef domain fill:#DFFFE0,stroke:#1A7F37,color:#1A7F37
    classDef data fill:#FFE8C0,stroke:#D9822B,color:#D9822B
    classDef core fill:#E2E2E2,stroke:#6C6C6C,color:#6C6C6C
    classDef external fill:#FFFFFF,stroke:#666666,stroke-dasharray: 5 5,color:#666666
```
