# drassapps/androidchallenge-passporter architecture

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

- Interactive diagram: https://gitdiagram.com/drassapps/androidchallenge-passporter
- Repository: https://github.com/drassapps/androidchallenge-passporter

## Overview

##### Project Type and Purpose
- This is an Android mobile application written in Kotlin that consumes GitHub’s REST API to display a paginated list of repositories.
- It follows MVVM architecture with a repository pattern, Hilt for DI, Retrofit + OkHttp for networking, Coroutines + Flow for async data streams, and Room for local persistence.

##### File‐Structure / Component Breakdown
- app/src/main/java/com/drassapps/androidchallenge/ui – UI layer: Activities, Adapters, ViewModels
- app/src/main/java/com/drassapps/androidchallenge/data/network – Networking: ApiService interfaces, Retrofit client wrapper (ServerSource)
- app/src/main/java/com/drassapps/androidchallenge/data/db – Local persistence: Room entities (RepoDB), DAOs (RepoDao), Database class (ReposDataBase), Data source (RoomDatSource)
- app/src/main/java/com/drassapps/androidchallenge/data/domain – Domain models (GitHubRepository, OwnerModel, RepoModel)
- app/src/main/java/com/drassapps/androidchallenge/di – Dependency injection modules (Network, ApiAuth)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation (UI)" 
        direction TB
        MVActivity["MainViewActivity (View)"]:::ui
        RepoAdapter["RepoAdapter (RecyclerView Adapter)"]:::ui
    end

    %% ViewModel & Domain Layer
    subgraph "ViewModel & Domain" 
        direction TB
        MainVM["MainViewModel"]:::vm
        GitHubRepo["GitHubRepository"]:::domain
        OwnerModel["OwnerModel"]:::domain
        RepoModel["RepoModel"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer" 
        direction TB
        Repository["Repository"]:::data
        RoomDS["RoomDatSource (Local)"]:::data
        ServerDS["ServerSource (Remote)"]:::data
        ReposDB["ReposDataBase"]:::data
        RepoDAO["RepoDao"]:::data
        RepoDB["RepoDB (Entity)"]:::data
    end

    %% External Service
    GitHubAPI["GitHub REST API"]:::external

    %% Dependency Injection Modules
    subgraph "DI Modules (Hilt)"
        direction TB
        NetworkMod["Network (OkHttpClient/Retrofit)"]:::di
        ApiAuthMod["ApiAuth"]:::di
    end

    %% Presentation to ViewModel
    MVActivity -->|"observes"| MainVM
    RepoAdapter -->|"binds data"| MVActivity

    %% ViewModel to Repository
    MainVM -->|"getRepositories(page)"| Repository

    %% Repository to Data Sources
    Repository -->|"readCache() / insertRepos()"| RoomDS
    Repository -->|"fetchFromNetwork()"| ServerDS

    %% Local DB relations
    RoomDS -->|"uses DAO"| RepoDAO
    RepoDAO -->|"entities"| RepoDB
    RepoDAO -->|"database"| ReposDB
    RoomDS --> ReposDB

    %% ServerSource to Networking
    ServerDS -->|"Retrofit call"| ApiService
    ApiService -->|"HTTP request"| NetworkMod
    NetworkMod -->|"calls API"| GitHubAPI
    ApiService -->|"returns JSON"| ServerDS

    %% Data flow back to ViewModel
    ServerDS -->|"maps to domain"| GitHubRepo
    GitHubRepo --> OwnerModel
    GitHubRepo --> RepoModel
    Repository -->|"emits Flow<RepoModel>"| MainVM
    MainVM -->|"updates UI"| MVActivity

    %% Hilt injections
    NetworkMod --> ApiService
    ApiAuthMod --> NetworkMod
    ApiAuthMod --> ApiService
    ApiAuthMod --> Repository
    ApiAuthMod --> RoomDS
    ApiAuthMod --> MainVM

    %% Click Events
    click MVActivity "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/ui/main/view/MainViewActivity.kt"
    click RepoAdapter "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/ui/main/adapter/RepoAdapter.kt"
    click MainVM "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/ui/main/viewmodel/MainViewModel.kt"
    click RoomDS "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/db/RoomDatSource.kt"
    click ServerDS "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/network/ServerSource.kt"
    click ApiService "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/network/ApiService.kt"
    click NetworkMod "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/di/Network.kt"
    click ApiAuthMod "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/di/ApiAuth.kt"
    click ReposDB "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/db/ReposDataBase.kt"
    click RepoDB "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/db/RepoDB.kt"
    click RepoDAO "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/db/RepoDao.kt"
    click GitHubRepo "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/domain/GitHubRepository.kt"
    click OwnerModel "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/domain/OwnerModel.kt"
    click RepoModel "https://github.com/drassapps/androidchallenge-passporter/blob/main/app/src/main/java/com/drassapps/androidchallenge/data/domain/RepoModel.kt"

    %% Styles
    classDef ui fill:#BBDEFB,stroke:#1E88E5,color:#0D47A1
    classDef vm fill:#C8E6C9,stroke:#43A047,color:#1B5E20
    classDef data fill:#FFF9C4,stroke:#FBC02D,color:#F57F17
    classDef external fill:#FFE0B2,stroke:#FB8C00,color:#E65100
    classDef di fill:#E1BEE7,stroke:#8E24AA,color:#4A148C
    classDef domain fill:#C5CAE9,stroke:#3949AB,color:#1A237E
```
