# android/kotlin-multiplatform-samples architecture

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

- Interactive diagram: https://gitdiagram.com/android/kotlin-multiplatform-samples
- Repository: https://github.com/android/kotlin-multiplatform-samples

## Overview

##### Project Type and Purpose
- Fruitties is a Kotlin Multiplatform mobile application sample.
- It demonstrates sharing business logic (network, database, view-model) between Android and iOS clients.
- Mobile clients fetch fruit data over HTTP (Ktor), cache it in a local DB (Room/SQLDelight/DataStore), and render it in native UIs (Jetpack Compose and SwiftUI).

##### File Structure
- Top-level modules:
- androidApp/ – Android client (Kotlin, Compose UI, Hilt/DI).
- iosApp/ – iOS client (SwiftUI app entry, views, DI bridge).
- shared/ – Kotlin Multiplatform module:
– commonMain/ – shared business logic (models, repository, API interface, ViewModel, DB definition).
– androidMain/ – Android-specific DI & manifest.
– iosMain/ – iOS-specific DI & ViewModel owner.
- Build scripts and Gradle KTS configuration for KMP.
- Database schemas under shared/schemas for SQLDelight or Room codegen.
- Network interface FruittieApi.kt using Ktor client.

##### Readme Insights
- “Sample app using Kotlin Multiplatform ViewModel, Room, DataStore and Ktor to fetch, store and display data.”
- Purpose: demonstrate common code reuse across platforms.

##### Main Components
a. Android App
– UI layer (MainActivity, ListScreen)
– DI container (App.kt)
– Platform adapter hooking into shared ViewModel
b. iOS App
– SwiftUI views (ContentView, CartView)
– DI/ViewModel owner (IOSViewModelOwner)
c. Shared Module
– ViewModel (MainViewModel)
– DataRepository
– DataSources:
- Remote: FruittieApi (Ktor client)
- Local: AppDatabase (SQLDelight/Room Dao) + CartDataStore (DataStore)
– Models (Fruittie, FruittiesResponse)
– DI container (AppContainer, Factory implementations)
d. External Services
– Remote REST API endpoint (HTTP server)

##### Relationships and Data Flow
- UI (Android/iOS) → ViewModel (shared)
- ViewModel → DataRepository
- DataRepository → [Remote API via Ktor] and → [Local DB/DataStore]
- Local DB/DataStore → cached data back to ViewModel
- ViewModel → UI updates

##### Architectural Patterns & Principles
- MVVM (View → ViewModel → Model/Data)
- Clean separation of concerns: UI, DI, business logic, data sources.
- Shared “commonMain” for platform-agnostic code; “androidMain”/“iosMain” for platform specifics.
- Dependency Injection via AppContainer/Factory pattern in shared module, with platform overrides.

##### Technologies & Frameworks
- Kotlin Multiplatform
- Ktor (HTTP client)
- SQLDelight or Room (local DB)
- DataStore (preferences/cart storage)
- Jetpack Compose (Android UI)
- SwiftUI (iOS UI)
- Gradle KTS for builds
- DI via simple Factory/AppContainer pattern

##### Final Checklist
- [ ] Clear module boundaries (androidApp, shared, iosApp).
- [ ] Labels specifying technologies (Ktor, SQLDelight, Compose, SwiftUI).
- [ ] Notes on DI pattern (AppContainer, Factory) and platform overrides.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Android App Layer
    subgraph "Android App"
        direction TB
        MA["MainActivity"]:::ui-blue
        LS["ListScreen"]:::ui-blue
        ADI["App.kt (DI)"]:::shared-green
        FA_android["Factory.android.kt"]:::shared-green
    end

    %% Shared Module Layer
    subgraph "Shared Module"
        direction TB
        AC["AppContainer"]:::shared-green
        FT["Factory"]:::shared-green
        MV["MainViewModel"]:::shared-green
        Repo["DataRepository"]:::shared-green
        subgraph "Data Sources"
            direction TB
            API["FruittieApi"]:::shared-green
            DBInt["AppDatabase.kt"]:::shared-green
            Schema["AppDatabase Schema"]:::shared-green
            DAO["FruittieDao"]:::shared-green
            DS["CartDataStore"]:::shared-green
        end
        subgraph "Models"
            direction TB
            FR["Fruittie"]:::shared-green
            FRR["FruittiesResponse"]:::shared-green
        end
    end

    %% iOS App Layer
    subgraph "iOS App"
        direction TB
        IOSApp["iOSApp"]:::ui-blue
        CV["ContentView"]:::ui-blue
        CaV["CartView"]:::ui-blue
        IVO["IOSViewModelOwner"]:::shared-green
        FA_native["Factory.native.kt"]:::shared-green
    end

    %% External Service
    EX["Remote REST API"]:::external-orange

    %% Connections
    MA -->|"init DI"| ADI
    ADI -->|"uses"| FA_android
    FA_android -->|"creates"| AC

    IOSApp -->|"init DI"| IVO
    IVO -->|"uses"| FA_native
    FA_native -->|"creates"| AC

    AC -->|"provides"| MV
    LS -->|"observes"| MV
    CV -->|"observes"| MV
    CaV -->|"observes"| MV

    MV -->|"calls"| Repo
    Repo -->|"HTTP/Ktor"| API
    Repo -->|"SQLDelight"| DBInt
    DBInt -->|"schema"| Schema
    DBInt -->|"queries"| DAO
    Repo -->|"DataStore"| DS
    API -->|"REST"| EX

    %% Click Events
    click MA "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/androidApp/src/main/java/com/example/fruitties/android/MainActivity.kt"
    click LS "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/androidApp/src/main/java/com/example/fruitties/android/ui/ListScreen.kt"
    click ADI "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/androidApp/src/main/java/com/example/fruitties/android/di/App.kt"
    click FA_android "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/androidMain/kotlin/com/example/fruitties/di/Factory.android.kt"

    click IOSApp "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/iosApp/iosApp/iOSApp.swift"
    click CV "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/iosApp/iosApp/ContentView.swift"
    click CaV "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/iosApp/iosApp/CartView.swift"
    click IVO "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/iosMain/kotlin/com/example/fruitties/di/viewmodel/IOSViewModelOwner.kt"
    click FA_native "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/iosMain/kotlin/com/example/fruitties/di/Factory.native.kt"

    click MV "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/viewmodel/MainViewModel.kt"
    click Repo "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/DataRepository.kt"
    click API "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/network/FruittieApi.kt"
    click DBInt "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/database/AppDatabase.kt"
    click Schema "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/schemas/com.example.fruitties.database.AppDatabase/1.json"
    click DAO "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/database/FruittieDao.kt"
    click DS "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/database/CartDataStore.kt"
    click FR "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/model/Fruittie.kt"
    click FRR "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/model/FruittiesResponse.kt"
    click AC "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/di/AppContainer.kt"
    click FT "https://github.com/android/kotlin-multiplatform-samples/blob/main/Fruitties/shared/src/commonMain/kotlin/com/example/fruitties/di/Factory.kt"

    %% Styles
    classDef ui-blue fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef shared-green fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external-orange fill:#FFA500,stroke:#333,stroke-width:1px
```
