# gauravk95/mvp-kotlin-android architecture

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

- Interactive diagram: https://gitdiagram.com/gauravk95/mvp-kotlin-android
- Repository: https://github.com/gauravk95/mvp-kotlin-android

## Overview

##### Project Type and Purpose
- This is an Android mobile‐client application template written in Kotlin.
- It implements the MVP (Model–View–Presenter) pattern, uses Dagger2 for dependency injection, RxJava2 for reactive streams, Retrofit2 for network calls, and Room for local persistence.

##### File Structure
- Top‐level “app” module contains:
- src/main/java/com/github/mvpbasearchitecture/base (BaseActivity, BasePresenter, etc.)
- data (models, local/remote sources, repositories)
- di (Dagger components & modules)
- ui (Activities, Fragments, Adapters, Presenters)
- utils (Rx schedulers, extension functions, font utilities)
- res (layouts, drawables, values)
- Build scripts & config: build.gradle, proguard rules, AndroidManifest, gradle wrapper.

##### README for Insights
- README explicitly calls out modules: base, data (with sub‐packages), di (component/module), ui (custom, adapters, main), utils.
- Provides an MVP architecture blueprint image—use this as a reference.

##### Main Components
a. View Layer
- MainActivity & MainFragment (UI)
- XML layouts (activity_main.xml, fragment_main.xml, item_main.xml)
b. Presenter Layer
- MainPresenter (implements MainContract.Presenter)
- BaseMVPActivity/BaseMVPFragment (generic wiring)
c. Data Layer
- AppDataRepository (repository façade)
- Local Data Source: Room (AppDatabase, ItemDao) + AppLocalDataSource
- Remote Data Source: Retrofit (APIService, NetworkAPIs) + AppRemoteDataSource
- Preferences: AppPreferences (SharedPreferences abstraction)
d. Dependency Injection
- ApplicationComponent & ApplicationModule
- ActivityComponent & ActivityModule
- NetworkModule, DataModule, DatabaseInfo, PreferenceInfo
e. External Services
f. Persistence
g. Utilities
- RxJava SchedulerProvider, extension methods, font utils (auxiliary nodes)

##### Relationships & Data Flow
- UI → Presenter: user actions trigger Presenter methods.
- Presenter → Repository: calls AppDataRepository.getItems() (returns Rx Observable/Single).
- Repository → DataSources: decides whether to fetch from local DB or network; merges results.
- Remote Data Source → Retrofit APIService → External HTTP service.
- Local Data Source → Room database via DAO.
- Repository emits data back to Presenter → Presenter updates View.
- DI graph: ApplicationComponent provides singletons (NetworkModule, DataModule); ActivityComponent injects Activities/Fragments.

##### Architectural Patterns & Technologies
- MVP (clear separation of View, Presenter, Model).
- Repository pattern for data abstraction.
- Retrofit2 for HTTP client.
- Room for local persistence.

##### Final Checklist
- Clear labels on all components (class names or group names).
- A note on the architectural pattern (MVP + Repository + DI + Rx + Retrofit + Room).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% View Layer
    subgraph "View Layer"
        A["MainActivity"]:::view
        B["MainFragment"]:::view
        C["activity_main.xml"]:::view
        D["fragment_main.xml"]:::view
        E["item_main.xml"]:::view
        A -->|launch| B
    end

    %% Presenter Layer
    subgraph "Presenter Layer"
        P1["MainPresenter"]:::presenter
        P2["BaseMVPActivity"]:::presenter
        P3["BaseMVPFragment"]:::presenter
        P4["BasePresenter"]:::presenter
    end

    %% Data Layer
    subgraph "Data Layer"
        Repo["AppDataRepository"]:::data
        LocalDS["AppLocalDataSource"]:::data
        RemoteDS["AppRemoteDataSource"]:::data
        DB["AppDatabase"]:::data
        DAO["ItemDao"]:::data
        API["APIService"]:::data
        NetAPI["NetworkAPIs"]:::data
        Pref["AppPreferences"]:::data
    end

    %% DI Layer
    subgraph "DI Layer"
        AC["ApplicationComponent"]:::di
        AMC["ApplicationModule"]:::di
        ACTC["ActivityComponent"]:::di
        AMod["ActivityModule"]:::di
        NM["NetworkModule"]:::di
        DM["DataModule"]:::di
        DBI["DatabaseInfo"]:::di
        PI["PreferenceInfo"]:::di
    end

    %% Utilities
    subgraph "Utilities"
        US["AppSchedulerProvider"]:::util
        UF["Extension Functions"]:::util
        UI["Font Utilities"]:::util
    end

    %% External/Infrastructure
    APICloud["REST API"]:::infra
    DBCylinder["Room DB"]:::infra

    %% Connections: View -> Presenter
    A -->|"attach()"| P1
    B -->|"attach()"| P1

    %% Presenter -> Repository
    P1 -->|"getItems()"| Repo

    %% Repository -> DataSources
    Repo -->|"fetchFromDb()"| LocalDS
    LocalDS -->|"dao()"| DAO
    LocalDS -->|"db()"| DB
    Repo -->|"fetchRemote()"| RemoteDS
    RemoteDS -->|"callApi()"| API
    API -->|"endpoints()"| NetAPI
    Repo -->|"getPrefs()"| Pref

    %% DataSources -> External/DB
    NetAPI -->|HTTP| APICloud
    DB -->|persistence| DBCylinder

    %% DI Graph
    AC --> AMC
    AC --> NM
    AC --> DM
    AC --> DBI
    AC --> PI
    ACTC --> AMod
    ACTC --> AC
    ACTC --> P2
    ACTC --> P3
    ACTC --> P1
    ACTC --> A
    ACTC --> B

    %% Utilities connections
    US -.-> P1
    US -.-> Repo
    UF -.-> P1
    UI -.-> A

    %% Click Events
    click A "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/ui/main/MainActivity.kt"
    click B "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/ui/main/MainFragment.kt"
    click C "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/res/layout/activity_main.xml"
    click D "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/res/layout/fragment_main.xml"
    click E "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/res/layout/item_main.xml"
    click P1 "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/ui/main/MainPresenter.kt"
    click P2 "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/base/BaseMVPActivity.kt"
    click P3 "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/base/BaseMVPFragment.kt"
    click P4 "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/base/BasePresenter.kt"
    click Repo "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/repository/AppDataRepository.kt"
    click LocalDS "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/repository/local/AppLocalDataSource.kt"
    click RemoteDS "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/repository/remote/AppRemoteDataSource.kt"
    click DB "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/db/AppDatabase.kt"
    click DAO "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/db/ItemDao.kt"
    click API "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/network/APIService.kt"
    click NetAPI "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/network/NetworkAPIs.kt"
    click Pref "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/data/source/prefs/AppPreferences.kt"
    click AC "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/component/ApplicationComponent.kt"
    click ACTC "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/component/ActivityComponent.kt"
    click AMC "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/module/ApplicationModule.kt"
    click AMod "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/module/ActivityModule.kt"
    click NM "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/module/NetworkModule.kt"
    click DM "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/module/DataModule.kt"
    click DBI "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/DatabaseInfo.kt"
    click PI "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/di/PreferenceInfo.kt"
    click US "https://github.com/gauravk95/mvp-kotlin-android/blob/master/app/src/main/java/com/github/mvpbasearchitecture/utils/rx/AppSchedulerProvider.kt"
    click UF "https://github.com/gauravk95/mvp-kotlin-android/tree/master/app/src/main/java/com/github/mvpbasearchitecture/utils/ext"
    click UI "https://github.com/gauravk95/mvp-kotlin-android/tree/master/app/src/main/java/com/github/mvpbasearchitecture/utils/font"

    %% Styles
    classDef view fill:#E0F7FA,stroke:#006064
    classDef presenter fill:#E8F5E9,stroke:#1B5E20
    classDef data fill:#FFF3E0,stroke:#E65100
    classDef di fill:#EDE7F6,stroke:#4A148C
    classDef util fill:#CFD8DC,stroke:#37474F
    classDef infra fill:#ECEFF1,stroke:#607D8B
```
