# patrickdip/kmm_socialmediaapp architecture

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

- Interactive diagram: https://gitdiagram.com/patrickdip/kmm_socialmediaapp
- Repository: https://github.com/patrickdip/kmm_socialmediaapp

## Overview

##### Project Type and Purpose
- This project is a mobile client for a Social Media App built using Kotlin Multiplatform. It contains cross-platform business logic (in the “shared” module) with platform-specific UIs for Android (fully implemented) and iOS (planned for future development).
- The project leverages native UI frameworks (Android UI components and Swift UI for iOS) while sharing domain, repository, networking, and other business-related layers.

##### Analyzing the File Structure
- The project is organized into three major directories:
- androidApp: Contains all Android-specific code including activities, view models, screens, and Android resources.
- iosApp: Contains the iOS project structure (Xcode project, assets, SwiftUI views), though it’s still minimal compared to Android.
- shared: Houses the core, platform-agnostic modules. This module is further divided into subdirectories (commonMain, androidMain, iosMain) along with packages for account, auth, post, follows, common (data, domain, util), and dependency injection. It encapsulates the business logic, use cases, repository implementations, API services, and shared utilities.
- Look for clear separations such as:
- Domain and use case layers (e.g., account/domain, auth/domain, post/domain).
- Data and networking layers (e.g., common/data/remote with KtorApi and related API services).
- Dependency Injection modules (e.g., PlatformModule in both android and shared directories).

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Android UI"
        A_UI["Android UI (Activities, Views, ViewModels)"]:::android
    end

    subgraph "iOS UI"
        I_UI["iOS UI (ContentView, iOSApp.swift - WIP)"]:::ios
    end

    subgraph "Shared Module"
        subgraph "Domain"
            Domain_Account["Account Domain"]:::domain
            Domain_Auth["Auth Domain"]:::domain
            Domain_Post["Post Domain"]:::domain
            Domain_Follows["Follows Domain"]:::domain
        end
        subgraph "Data"
            Data_Account["Account Data"]:::data
            Data_Auth["Auth Data"]:::data
            Data_Post["Post Data"]:::data
            Data_Remote["Remote API Services"]:::data
        end
        subgraph "Dependency Injection"
            DI_Android["Android DI"]:::di
            DI_Shared["Shared DI"]:::di
            DI_Platform_Android["Platform DI (Android)"]:::di
            DI_Platform_iOS["Platform DI (iOS)"]:::di
        end
        subgraph "Utilities"
            Util_Android["Android Utilities"]:::util
            Util_Shared["Shared Utilities"]:::util
        end
    end

    %% UI to Domain interactions
    A_UI -->|"calls"| Domain_Auth
    A_UI -->|"calls"| Domain_Account
    A_UI -->|"calls"| Domain_Post
    A_UI -->|"calls"| Domain_Follows
    I_UI -->|"calls"| Domain_Auth

    %% Domain to Data interactions
    Domain_Auth -->|"calls"| Data_Auth
    Domain_Account -->|"calls"| Data_Account
    Domain_Post -->|"calls"| Data_Post
    Domain_Follows -->|"calls"| Data_Remote

    %% Data layers calling remote API
    Data_Auth -->|"apiCall"| Data_Remote
    Data_Account -->|"apiCall"| Data_Remote
    Data_Post -->|"apiCall"| Data_Remote

    %% Dependency Injection wiring
    DI_Android -->|"injects"| A_UI
    DI_Platform_Android -->|"platformInjects"| A_UI
    DI_Platform_iOS -->|"platformInjects"| I_UI
    DI_Shared -->|"wires"| Domain_Auth
    DI_Shared -->|"wires"| Domain_Account
    DI_Shared -->|"wires"| Domain_Post
    DI_Shared -->|"wires"| Domain_Follows

    %% Utilities usage
    A_UI -->|"utilizes"| Util_Android
    Domain_Auth -->|"uses"| Util_Shared
    Domain_Account -->|"uses"| Util_Shared
    Domain_Post -->|"uses"| Util_Shared
    Domain_Follows -->|"uses"| Util_Shared

    %% Click Events
    click A_UI "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/androidApp/src/main/java/com/dipumba/ytsocialapp/android"
    click I_UI "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/iosApp/iosApp"
    click Domain_Account "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/account/domain"
    click Domain_Auth "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/auth/domain"
    click Domain_Post "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/post/domain"
    click Domain_Follows "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/follows/domain"
    click Data_Account "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/account/data"
    click Data_Auth "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/auth/data"
    click Data_Post "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/post/data"
    click Data_Remote "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/common/data/remote"
    click DI_Android "https://github.com/patrickdip/kmm_socialmediaapp/blob/main/androidApp/src/main/java/com/dipumba/ytsocialapp/android/di/AppModule.kt"
    click DI_Shared "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/di"
    click DI_Platform_Android "https://github.com/patrickdip/kmm_socialmediaapp/blob/main/shared/src/androidMain/kotlin/com/dipumba/ytsocialapp/di/PlatformModule.kt"
    click DI_Platform_iOS "https://github.com/patrickdip/kmm_socialmediaapp/blob/main/shared/src/iosMain/kotlin/com/dipumba/ytsocialapp/di/PlatformModule.kt"
    click Util_Android "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/androidApp/src/main/java/com/dipumba/ytsocialapp/android/common/util"
    click Util_Shared "https://github.com/patrickdip/kmm_socialmediaapp/tree/main/shared/src/commonMain/kotlin/com/dipumba/ytsocialapp/common/util"

    %% Styles
    classDef android fill:#ADD8E6,stroke:#333,stroke-width:2px;
    classDef ios fill:#90EE90,stroke:#333,stroke-width:2px;
    classDef domain fill:#FFD700,stroke:#333,stroke-width:2px;
    classDef data fill:#FFA07A,stroke:#333,stroke-width:2px;
    classDef di fill:#DDA0DD,stroke:#333,stroke-width:2px;
    classDef util fill:#E6E6FA,stroke:#333,stroke-width:2px;
```
