# ricarlo-silva/cmp-app-recipes architecture

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

- Interactive diagram: https://gitdiagram.com/ricarlo-silva/cmp-app-recipes
- Repository: https://github.com/ricarlo-silva/cmp-app-recipes

## Overview

##### Project type and purpose
- This is a cross-platform mobile application (“CMP App Recipes”) targeting Android and iOS, built with Kotlin Multiplatform and Compose Multiplatform (CMP).
- It separates shared business/UI logic from platform-specific implementation.

##### File structure
- Top-level modules:
- androidApp: Android UI & entry point
- iosApp: iOS UI & entry point
- shared: Common Kotlin logic & shared CMP UI
- core:
– designsystem: shared UI building blocks
– network: shared HTTP client & networking abstractions
- feature/login: shared login feature
- build-logic: custom Gradle plugins & build conventions
- The dependency graph (shared → core/designsystem + core/network + feature) → platform apps.

##### README for additional insights
- Uses Compose Multiplatform for UI
- Koin for DI
- Ktor for HTTP
- GitHub Actions for CI/CD

a. Main components
1. Android App (androidApp module)
2. iOS App (iosApp module)
3. Shared CMP Module (shared)
4. Core – DesignSystem (UI toolkit)
5. Core – Network (Ktor client & TokenManager)
6. Feature – Login (business logic & screens)
7. External Services (REST API, Backend)
8. Build & CI (build-logic + GitHub Actions)
b. Relationships & interactions
- androidApp & iosApp depend on shared, core/designsystem, core/network, and feature/login
- shared module composes UI with DesignSystem and invokes network APIs via core/network
- feature/login sits atop shared and core modules, exposing login use-cases to the UI
- Koin runs in each platform app to wire up shared + core modules
- At runtime, network layer (Ktor) calls out to external REST endpoints and returns data back up to UI
c. Architectural patterns & principles
- Modular monolith: multi-module separation by concern (shared, core, feature, platform)
- Dependency Injection (Koin) for loose coupling
- Layered architecture: UI → Feature → Domain (shared) → Network → External
- MPP abstraction: commonMain / androidMain / iosMain sources
d. Key technologies
- Kotlin Multiplatform & Compose Multiplatform
- Koin (DI)
- Ktor (HTTP client)
- Gradle custom plugins (build-logic)
- GitHub Actions for CI/CD

##### Essential architectural elements to capture
- MPP layering (commonMain vs androidMain vs iosMain)
- Module dependencies (shared ← core/designsystem, core/network, feature/login)
- Platform entry points and DI setup
- Network communication boundary
- Build-time plugins and CI integration

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Platform Layer
    subgraph "Platform Layer"
        direction TB
        AndroidApp["Android App\n(androidApp)"]:::platform
        IOSApp["iOS App\n(iosApp)"]:::platform
    end

    %% Shared Modules
    subgraph "Shared Modules"
        direction TB
        Shared["Shared CMP Module\n(shared)"]:::shared
        DesignSystem["Core - DesignSystem\n(core/designsystem)"]:::core
        Network["Core - Network\n(core/network)"]:::core
        LoginFeature["Feature - Login\n(feature/login)"]:::feature
    end

    %% External Systems
    ExternalAPI["External REST API\n(Backend)"]:::external

    %% Build & CI
    BuildCI["Build & CI\n(build-logic + GitHub Actions)"]:::build

    %% Connections
    AndroidApp -->|"depends on"| Shared
    IOSApp -->|"depends on"| Shared

    Shared -->|"uses UI toolkit"| DesignSystem
    Shared -->|"invokes network"| Network
    Shared -->|"exposes use-cases"| LoginFeature

    LoginFeature -->|"login request"| Network
    Network -->|"HTTP call"| ExternalAPI
    ExternalAPI -->|"response"| Network
    Network -->|"data"| LoginFeature
    LoginFeature -->|"data for UI"| Shared
    Shared -->|"renders UI"| AndroidApp
    Shared -->|"renders UI"| IOSApp

    BuildCI --> AndroidApp
    BuildCI --> IOSApp
    BuildCI --> Shared
    BuildCI --> DesignSystem
    BuildCI --> Network
    BuildCI --> LoginFeature

    %% Click Events
    click AndroidApp "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/androidApp/build.gradle.kts"
    click AndroidApp "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/androidApp/src/main/java/br/com/ricarlo/cmp_app_recipes/android/MainActivity.kt"
    click AndroidApp "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/androidApp/src/main/AndroidManifest.xml"

    click IOSApp "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/iosApp/iosApp/iOSApp.swift"
    click IOSApp "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/iosApp/iosApp/ContentView.swift"
    click IOSApp "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/iosApp/iosApp/Info.plist"
    click IOSApp "https://github.com/ricarlo-silva/cmp-app-recipes/tree/main/iosApp/Podfile"

    click Shared "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/shared/build.gradle.kts"
    click Shared "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/shared/src/commonMain/kotlin/br/com/ricarlo/cmp_app_recipes/App.kt"
    click Shared "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/shared/src/commonMain/kotlin/br/com/ricarlo/cmp_app_recipes/Greeting.kt"
    click Shared "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/shared/src/androidMain/kotlin/br/com/ricarlo/cmp_app_recipes/AppAndroidPreview.kt"
    click Shared "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/shared/src/iosMain/kotlin/br/com/ricarlo/cmp_app_recipes/MainViewController.kt"

    click DesignSystem "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/designsystem/build.gradle.kts"
    click DesignSystem "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/designsystem/src/commonMain/kotlin/br/com/ricarlo/designsystem/MyApplicationTheme.kt"
    click DesignSystem "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/designsystem/src/commonMain/kotlin/br/com/ricarlo/designsystem/System.kt"
    click DesignSystem "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/designsystem/src/androidMain/kotlin/br/com/ricarlo/designsystem/System.android.kt"
    click DesignSystem "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/designsystem/src/iosMain/kotlin/br/com/ricarlo/designsystem/System.ios.kt"

    click Network "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/network/build.gradle.kts"
    click Network "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/network/src/commonMain/kotlin/br/com/ricarlo/network/KtorHttpClient.kt"
    click Network "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/network/src/commonMain/kotlin/br/com/ricarlo/network/TokenManager.kt"
    click Network "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/network/src/commonMain/kotlin/br/com/ricarlo/network/Platform.kt"
    click Network "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/network/src/commonMain/kotlin/br/com/ricarlo/network/utils/AppLogger.kt"
    click Network "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/network/src/androidMain/kotlin/br/com/ricarlo/network/Platform.android.kt"
    click Network "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/core/network/src/iosMain/kotlin/br/com/ricarlo/network/Platform.ios.kt"

    click LoginFeature "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/feature/login/build.gradle.kts"
    click LoginFeature "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/feature/login/src/commonMain/kotlin/br/com/ricarlo/login/Platform.kt"
    click LoginFeature "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/feature/login/src/androidMain/kotlin/br/com/ricarlo/login/Platform.android.kt"
    click LoginFeature "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/feature/login/src/iosMain/kotlin/br/com/ricarlo/login/Platform.ios.kt"

    click BuildCI "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/build-logic/convention/build.gradle.kts"
    click BuildCI "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/build-logic/convention/src/main/kotlin/MavenPublishConventionPlugin.kt"
    click BuildCI "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/.github/workflows/build.yml"
    click BuildCI "https://github.com/ricarlo-silva/cmp-app-recipes/blob/main/.github/workflows/main.yml"

    %% Styles
    classDef platform fill:#a2f5a2,stroke:#2d7a2d,color:#000
    classDef shared fill:#a2c8f5,stroke:#22568c,color:#000
    classDef core fill:#d0e7f9,stroke:#2b5d7a,color:#000
    classDef feature fill:#f5c8a2,stroke:#7a4f2d,color:#000
    classDef external fill:#cccccc,stroke:#666666,color:#000
    classDef build fill:#f5f1a2,stroke:#7a7744,color:#000
```
