# 7und3dpy/mobile-programming-project architecture

> Architecture diagram of the GitHub repository 7und3dpy/mobile-programming-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/7und3dpy/mobile-programming-project
- Repository: https://github.com/7und3dpy/mobile-programming-project

## Overview

##### Project type and purpose
- This is a single-module Android mobile application (“Dogs Application”) built in Kotlin. It follows MVVM (Model-View-ViewModel), uses Jetpack components (ViewModel, Room, Paging 3), Retrofit/Moshi for networking, and Hilt for dependency injection. Its purpose is to fetch, cache, paginate, and display a list of dog images/data in a RecyclerView.

##### File structure
- Top-level “app” module with Gradle, ProGuard, tests, AndroidManifest, etc.
- Under `app/src/main/java/turio/it4785e/displaydog` you see these packages:
- `ui` (MainActivity, MainViewModel, layouts, adapter) – presentation layer
- `data` (model, dao, database, repository/RemoteMediator) – data layer
- `network` (ApiService) – remote data source
- `di` (AppModule) – DI definition
- `adapter` – RecyclerView adapter
- Configuration files: Hilt setup in `AppModule`, Room schema in `Database.kt`, Retrofit in `ApiService`.

##### README for additional insights
- Confirms use of Coroutines, Flow, Paging 3, Room, Retrofit, Moshi, Coil, Material Components, JUnit/Espresso, MultiDex.

##### Main components
a. Presentation Layer
- UI: MainActivity + XML layouts + DogsAdapter
- ViewModel: MainViewModel (exposes Flow/LiveData to the UI)
b. Dependency Injection
- Hilt AppComponent & AppModule (provides ApiService, Database, DAOs, Repository)
c. Data Layer
- Repository: DogsRemoteMediator implements PagingSource + RemoteMediator
- Local Data Source: Room Database + DogsDao + RemoteKeysDao
- Remote Data Source: Retrofit ApiService + Moshi converter
d. External Services
- REST API endpoint (hosted externally; returns paginated dog data)
e. Cross-cutting
- Kotlin Coroutines & Flow (across ViewModel, Repository, networking, DB threads)

##### Relationships and interactions
- Repository →
- Hilt provides all dependencies into ViewModel, Repository, ApiService, Database

##### Architectural patterns and principles
- MVVM: clear separation of UI, state management (ViewModel), and data sources
- Repository + RemoteMediator: abstracts paging and caching logic
- Single source of truth: local Room database backed by network
- Dependency inversion via Hilt modules

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Infrastructure (DI)"
        BaseApp["BaseApplication"]:::infra
        AppComponent["Hilt AppComponent"]:::infra
        AppModule["AppModule"]:::infra
    end

    subgraph "Presentation Layer"
        MainActivity["MainActivity"]:::presentation
        Layout1["activity_main.xml"]:::presentation
        Layout2["each_dog.xml"]:::presentation
        MainViewModel["MainViewModel"]:::presentation
        DogsAdapter["DogsAdapter"]:::presentation
    end

    subgraph "Business Layer"
        DogsRemoteMediator["DogsRemoteMediator\n(Paging3 & Coroutines)"]:::domain
    end

    subgraph "Data & Network Layer"
        subgraph "Local Data Source"
            Database["Room Database"]:::data
            DogsDao["DogsDao"]:::data
            RemoteKeysDao["RemoteKeysDao"]:::data
        end
        ApiService["ApiService\n(Retrofit + Moshi)"]:::data
    end

    %% Dependency flows
    BaseApp --> AppComponent
    AppComponent -->|provides| MainViewModel
    AppComponent -->|provides| DogsRemoteMediator
    AppComponent -->|provides| ApiService
    AppComponent -->|provides| Database

    %% Presentation interactions
    MainActivity -->|observes| MainViewModel
    MainActivity -->|uses| DogsAdapter
    MainActivity -->|inflates| Layout1
    MainActivity -->|inflates| Layout2
    MainViewModel -->|calls| DogsRemoteMediator
    DogsRemoteMediator -.->|emits Flow| MainViewModel

    %% Business to Data interactions
    DogsRemoteMediator -->|reads/writes| DogsDao
    DogsRemoteMediator -->|reads/writes| RemoteKeysDao
    DogsRemoteMediator -->|fetches via| ApiService
    DogsDao -->|operates on| Database
    RemoteKeysDao -->|operates on| Database

    %% Styling
    classDef presentation fill:#ADD8E6,stroke:#000;
    classDef domain fill:#90EE90,stroke:#000;
    classDef data fill:#FFA500,stroke:#000;
    classDef infra fill:#D3D3D3,stroke:#000;

    %% Click Events
    click MainActivity "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/ui/MainActivity.kt"
    click Layout1 "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/res/layout/activity_main.xml"
    click Layout2 "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/res/layout/each_dog.xml"
    click MainViewModel "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/ui/MainViewModel.kt"
    click DogsAdapter "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/adapter/DogsAdapter.kt"
    click AppModule "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/di/AppModule.kt"
    click BaseApp "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/BaseApplication.kt"
    click DogsRemoteMediator "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/data/repository/DogsRemoteMediator.kt"
    click Database "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/data/database/Database.kt"
    click DogsDao "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/data/dao/DogsDao.kt"
    click RemoteKeysDao "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/data/dao/RemoteKeysDao.kt"
    click ApiService "https://github.com/7und3dpy/mobile-programming-project/blob/main/app/src/main/java/turio/it4785e/displaydog/network/ApiService.kt"
```
