# muhammedelsami/compose-splash-onboarding-home architecture

> Architecture diagram of the GitHub repository muhammedelsami/compose-splash-onboarding-home, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/muhammedelsami/compose-splash-onboarding-home
- Repository: https://github.com/muhammedelsami/compose-splash-onboarding-home

## Overview

##### Project type and purpose
- This is a modern single-activity Android application built with Jetpack Compose.
- Purpose: demonstrate a splash screen, an onboarding flow, and a home screen, with onboarding state persisted via DataStore.

##### File structure
- Top level: Gradle build files, settings, version catalogs.
- “app” module:
- build.gradle.kts, proguard rules – build configuration
- src/main/java/.../App.kt & MainActivity.kt – application & activity entry points
- data/datastore/DataStoreManager.kt – persistence layer encapsulating DataStore
- presentation/… – UI layer organized by feature (splash, onboarding, home) plus navigation
- Tests under androidTest and test: instrumentation and unit tests

##### Insights from README
- Confirms single-activity Jetpack Compose architecture
- Uses Navigation Component for screen routing
- DataStore for local persistence of onboarding completion

##### Main components
a. Android Framework Layer
– Android OS
– Activity Host: MainActivity
– Application class: App
b. UI Layer (Jetpack Compose)
– SplashScreen composable
– OnboardingScreen & OnboardingPage composables
– HomeScreen composable
c. Navigation Component
– NavHost (AppNavHost)
– Route definitions (Routes.kt)
– Navigation graph linking splash → onboarding → home
d. Data Layer
– DataStoreManager: read/write onboarding flag via Proto/DataStore
– DataStore files under app-internal storage
e. Build & CI
– Gradle (KTS) scripts, version catalog, proguard, wrapper

##### Relationships and data flows
- App→MainActivity launches NavHost
- NavHost controls which composable to display based on navigation state
- SplashScreen queries DataStoreManager (suspend)
- DataStoreManager returns “hasCompletedOnboarding” → NavHost routes to Onboarding or Home
- OnboardingScreen on completion writes flag via DataStoreManager
- HomeScreen displays main content
- Theme provider wraps all composables

##### Architectural patterns & design principles
- Single-Activity + multiple Compose screens
- Separation of concerns: UI layer vs. Data layer
- Unidirectional data flow: UI invokes DataStore through Manager, Manager returns state
- Dependency injection can be added around DataStoreManager (if desired)

##### Technologies & frameworks
- Kotlin + Coroutines
- Jetpack Compose UI
- Navigation Component for Compose
- DataStore (Preferences or Proto)
- Gradle KTS build system

##### Final checklist
– Clear, descriptive labels for each component
– Group related files/features together (presentation, data, resources)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Android Framework Layer
    subgraph "Android Framework"
        App["App"]:::androidfw
        MainActivity["MainActivity"]:::androidfw
    end
    App --> MainActivity

    %% Navigation Component
    MainActivity --> NavHost["AppNavHost"]:::nav
    NavHost --> Routes["Routes"]:::nav

    %% UI / Compose Layer
    subgraph "UI / Compose"
        Theme["Theme Provider\n(MaterialTheme)"]:::ui
        Colors["Color.kt"]:::ui
        Type["Type.kt"]:::ui
        subgraph "Screens"
            Splash["SplashScreen"]:::ui
            Onboarding["OnboardingScreen"]:::ui
            OnboardingPage["OnboardingPage"]:::ui
            Home["HomeScreen"]:::ui
        end
    end
    NavHost --> Theme
    Theme --> Colors
    Theme --> Type
    Theme --> Splash
    Splash --> Onboarding
    Onboarding --> Home

    %% Data Layer
    subgraph "Data Layer"
        DataStoreMgr["DataStoreManager"]:::data
        Store["DataStore Storage"]:::storage
    end
    DataStoreMgr -- reads/writes --> Store
    Splash -->|"getOnboardingState() → Boolean"| DataStoreMgr
    Onboarding -->|"setOnboardingCompleted()"| DataStoreMgr

    %% Build & CI
    subgraph "Build & CI"
        GradleApp["build.gradle.kts"]:::build
        ProGuard["proguard-rules.pro"]:::build
        Versions["libs.versions.toml"]:::build
        Settings["settings.gradle.kts"]:::build
    end

    %% Click Events
    click App "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/App.kt"
    click MainActivity "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/MainActivity.kt"
    click Splash "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/presentation/splash/SplashScreen.kt"
    click Onboarding "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/presentation/onboarding/OnboardingScreen.kt"
    click OnboardingPage "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/presentation/onboarding/OnboardingPage.kt"
    click Home "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/presentation/home/HomeScreen.kt"
    click Theme "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/ui/theme/Theme.kt"
    click Colors "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/ui/theme/Color.kt"
    click Type "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/ui/theme/Type.kt"
    click NavHost "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/presentation/navigation/AppNavHost.kt"
    click Routes "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/presentation/navigation/Routes.kt"
    click DataStoreMgr "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/src/main/java/com/muhammed/composesplashonboarhomeproject/data/datastore/DataStoreManager.kt"
    click GradleApp "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/build.gradle.kts"
    click ProGuard "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/app/proguard-rules.pro"
    click Versions "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/gradle/libs.versions.toml"
    click Settings "https://github.com/muhammedelsami/compose-splash-onboarding-home/blob/main/settings.gradle.kts"

    %% Styles
    classDef androidfw fill:#d3d3d3,stroke:#333;
    classDef nav fill:#87CEEB,stroke:#333;
    classDef ui fill:#ADD8E6,stroke:#333;
    classDef data fill:#90EE90,stroke:#333;
    classDef storage fill:#FFA500,stroke:#333,shape:cylinder;
    classDef build fill:#f0e68c,stroke:#333;
```
