# android/androidify architecture

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

- Interactive diagram: https://gitdiagram.com/android/androidify
- Repository: https://github.com/android/androidify

## Overview

##### Project Type and Purpose
- This is an open-source, full-stack Android application (“Androidify”) demonstrating AI-driven avatar creation. It uses Jetpack Compose for UI, CameraX for camera features, Firebase AI Logic SDK (Gemini API) for image/text generation, and Navigation 3 for Compose navigation. The code is highly modularized into Gradle modules to separate features and core services.

##### Key Architectural Components
a. App Module (app)
- Entry point for the Android application.
- Hosts the AndroidifyApplication (Application subclass), MainActivity, and configures Navigation.
- Depends on feature modules, core modules (network, util, theme), and data modules.
b. Feature Modules (feature/home, feature/camera, feature/creation, feature/results)
- Each provides a Compose screen, ViewModel (MVVM), UI components, and tests.
- Expose navigation routes and interact with shared data services via interfaces in “data” module.
c. Data Module (data)
- Defines repositories (ImageGenerationRepository, TextGenerationRepository) and data sources.
- Provides Retrofit/network abstractions and connectivity management.
- Supplies DI (DataModule) for ViewModels across features.
d. Core Modules
- core/network: Network clients, Firebase initializers, RemoteConfigDataSource, Vertex AI data source, DI (NetworkModule).
- core/theme: Shared Compose theming, custom brushes, transitions.
- core/util: Utility classes (file provider, graphics, layout, animation helpers).
- core/testing: Test runners, fake data sources, repository fakes for unit/integration tests.
e. External Services
- Firebase (App Check, Remote Config, AI Logic SDK).
- Vertex AI / Imagen and Gemini models via FirebaseAiDataSource.
f. Benchmark Module (benchmark)
- Contains performance and startup benchmarks for the app’s AI and UI flows.

##### Relationships and Data Flow
- UI Layer (Compose Screens in feature modules) ← ViewModels (feature/*.ViewModel) ← Repositories (data module) ← DataSources (core/network).
- Navigation component coordinates between feature screens via MainNavigation.
- NetworkModule (Hilt or manual DI) provides singletons for Retrofit, Firebase, RemoteConfig.
- DataModule provides repository implementations to ViewModels.
- CameraX component (feature/camera) interacts with CameraProvider and feeds bitmaps to the ImageGenerationRepository.
- Generated images/text pass back from the AI service through repositories to the ViewModel, then rendered in a Compose UI screen (feature/results).
- Remote Config can alter endpoints or feature toggles at runtime.

##### Architectural Patterns and Design Principles
- MVVM: Each screen has a ViewModel that exposes UI state and events.
- Modularization: Separate Gradle modules per feature and core capability for compile-time isolation and faster build times.
- Dependency Injection: NetworkModule and DataModule supply singletons and interfaces for testability.
- Clean Separation: UI vs. business logic vs. data sources vs. external services.
- Compose Navigation Graph: Defined in MainNavigation, decoupled per feature.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% App Host Module
    subgraph "App Host"
        direction TB
        AApp["AndroidifyApplication"]:::app
        AMainActivity["MainActivity"]:::app
        AMainNav["MainNavigation"]:::app
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        HS["HomeScreen"]:::feature
        HVM["HomeViewModel"]:::feature
        CS["CameraScreen"]:::feature
        CVM["CameraViewModel"]:::feature
        CRS["CreationScreen"]:::feature
        CRVM["CreationViewModel"]:::feature
        RS["ResultsScreen"]:::feature
        RVM["ResultsViewModel"]:::feature
    end

    %% Domain/Data Layer
    subgraph "Domain/Data Layer"
        direction TB
        DM["DataModule"]:::data
        IGR["ImageGenerationRepository"]:::data
        TGR["TextGenerationRepository"]:::data
        ICM["InternetConnectivityManager"]:::data
        GNDS["GeminiNanoGenerationDataSource"]:::data
    end

    %% Infrastructure Layer
    subgraph "Infrastructure Layer"
        direction TB
        %% Core Network
        subgraph "core/network"
            direction TB
            NM["NetworkModule"]:::infra
            RCDS["RemoteConfigDataSource"]:::infra
            FADS["FirebaseAiDataSource"]:::infra
            FAInit["FirebaseAppInitializer"]:::infra
            FACInit["FirebaseAppCheckInitializer"]:::infra
            FRCInit["FirebaseRemoteConfigInitializer"]:::infra
        end
        %% Core Theme
        subgraph "core/theme"
            direction TB
            TH["Theme.kt"]:::infra
            CM["Color & Motion"]:::infra
            SC["Shared Components"]:::infra
        end
        %% Core Util
        subgraph "core/util"
            direction TB
            LU["LayoutUtils.kt"]:::infra
            AU["AnimationUtils.kt"]:::infra
            GU["GraphicsUtils.kt"]:::infra
            AP["AdaptivePreview.kt"]:::infra
            LP["LocalFileProvider.kt"]:::infra
        end
    end

    %% Core Testing
    subgraph "Core Testing"
        direction TB
        TRunner["AndroidifyTestRunner"]:::testing
        FImageFake["FakeImageGenerationRepository"]:::testing
        TFirebaseFake["TestFirebaseAiDataSource"]:::testing
    end

    %% Benchmark Module
    subgraph "Benchmark Module"
        direction TB
        PB["PromptBenchmark"]:::benchmark
        SB["StartupBenchmark"]:::benchmark
    end

    %% External Systems
    subgraph "External Systems"
        direction TB
        EFAC["Firebase App Check"]:::external
        EFRC["Firebase Remote Config"]:::external
        EAI["Firebase AI Logic SDK (Gemini)"]:::external
        EVA["Vertex AI / Imagen"]:::external
    end

    %% Relationships
    HS --> HVM
    CS --> CVM
    CRS --> CRVM
    RS --> RVM

    %% ViewModels to Repos
    CVM -->|uses| IGR
    CRVM -->|uses| IGR
    RVM -->|uses Image| IGR
    RVM -->|uses Text| TGR

    %% DI Module to Repos
    DM --> IGR
    DM --> TGR
    DM --> ICM
    DM --> GNDS

    %% Repos to DataSources
    IGR --> GNDS
    TGR --> FADS

    %% DataSources to NetworkModule and Firebase sources
    GNDS --> FADS
    FADS --> NM
    RCDS --> NM

    %% NetworkModule initializers
    NM --> FAInit
    NM --> FACInit
    NM --> FRCInit

    %% External services
    FAInit --> EFAC
    FRCInit --> EFRC
    FADS --> EAI
    FADS --> EVA

    %% App Host dependencies
    AApp --> AMainActivity
    AMainActivity --> AMainNav
    AMainNav --> HS
    AMainNav --> CS
    AMainNav --> CRS
    AMainNav --> RS
    AMainActivity --> DM
    AMainActivity --> NM

    %% Testing relationships
    TRunner -.-> DM
    TRunner -.-> NM
    TRunner -.-> IGR
    TRunner -.-> FADS
    FImageFake -.-> IGR
    TFirebaseFake -.-> FADS

    %% Benchmark links
    PB --> NM
    PB --> DM
    SB --> AApp

    %% Click Events
    click AApp "https://github.com/android/androidify/blob/main/app/src/main/java/com/android/developers/androidify/AndroidifyApplication.kt"
    click AMainActivity "https://github.com/android/androidify/blob/main/app/src/main/java/com/android/developers/androidify/MainActivity.kt"
    click AMainNav "https://github.com/android/androidify/blob/main/app/src/main/java/com/android/developers/androidify/navigation/MainNavigation.kt"
    click HS "https://github.com/android/androidify/blob/main/feature/home/src/main/java/com/android/developers/androidify/home/HomeScreen.kt"
    click HVM "https://github.com/android/androidify/blob/main/feature/home/src/main/java/com/android/developers/androidify/home/HomeViewModel.kt"
    click CS "https://github.com/android/androidify/blob/main/feature/camera/src/main/java/com/android/developers/androidify/camera/CameraScreen.kt"
    click CVM "https://github.com/android/androidify/blob/main/feature/camera/src/main/java/com/android/developers/androidify/camera/CameraViewModel.kt"
    click CRS "https://github.com/android/androidify/blob/main/feature/creation/src/main/java/com/android/developers/androidify/creation/CreationScreen.kt"
    click CRVM "https://github.com/android/androidify/blob/main/feature/creation/src/main/java/com/android/developers/androidify/creation/CreationViewModel.kt"
    click RS "https://github.com/android/androidify/blob/main/feature/results/src/main/java/com/android/developers/androidify/results/ResultsScreen.kt"
    click RVM "https://github.com/android/androidify/blob/main/feature/results/src/main/java/com/android/developers/androidify/results/ResultsViewModel.kt"
    click DM "https://github.com/android/androidify/blob/main/data/src/main/java/com/android/developers/androidify/data/DataModule.kt"
    click IGR "https://github.com/android/androidify/blob/main/data/src/main/java/com/android/developers/androidify/data/ImageGenerationRepository.kt"
    click TGR "https://github.com/android/androidify/blob/main/data/src/main/java/com/android/developers/androidify/data/TextGenerationRepository.kt"
    click ICM "https://github.com/android/androidify/blob/main/data/src/main/java/com/android/developers/androidify/data/InternetConnectivityManager.kt"
    click GNDS "https://github.com/android/androidify/blob/main/data/src/main/java/com/android/developers/androidify/data/GeminiNanoGenerationDataSource.kt"
    click NM "https://github.com/android/androidify/blob/main/core/network/src/main/java/com/android/developers/androidify/di/NetworkModule.kt"
    click RCDS "https://github.com/android/androidify/blob/main/core/network/src/main/java/com/android/developers/androidify/RemoteConfigDataSource.kt"
    click FADS "https://github.com/android/androidify/blob/main/core/network/src/main/java/com/android/developers/androidify/vertexai/FirebaseAiDataSource.kt"
    click FAInit "https://github.com/android/androidify/blob/main/core/network/src/main/java/com/android/developers/androidify/startup/FirebaseAppInitializer.kt"
    click FACInit "https://github.com/android/androidify/blob/main/core/network/src/main/java/com/android/developers/androidify/startup/FirebaseAppCheckInitializer.kt"
    click FRCInit "https://github.com/android/androidify/blob/main/core/network/src/main/java/com/android/developers/androidify/startup/FirebaseRemoteConfigInitializer.kt"
    click TH "https://github.com/android/androidify/blob/main/core/theme/src/main/java/com/android/developers/androidify/theme/Theme.kt"
    click LU "https://github.com/android/androidify/blob/main/core/util/src/main/java/com/android/developers/androidify/util/LayoutUtils.kt"
    click AU "https://github.com/android/androidify/blob/main/core/util/src/main/java/com/android/developers/androidify/util/AnimationUtils.kt"
    click GU "https://github.com/android/androidify/blob/main/core/util/src/main/java/com/android/developers/androidify/util/GraphicsUtils.kt"
    click AP "https://github.com/android/androidify/blob/main/core/util/src/main/java/com/android/developers/androidify/util/AdaptivePreview.kt"
    click LP "https://github.com/android/androidify/blob/main/core/util/src/main/java/com/android/developers/androidify/util/LocalFileProvider.kt"
    click TRunner "https://github.com/android/androidify/blob/main/core/testing/src/main/java/com/android/developers/testing/AndroidifyTestRunner.kt"
    click FImageFake "https://github.com/android/androidify/blob/main/core/testing/src/main/java/com/android/developers/testing/repository/FakeImageGenerationRepository.kt"
    click TFirebaseFake "https://github.com/android/androidify/blob/main/core/testing/src/main/java/com/android/developers/testing/network/TestFirebaseAiDataSource.kt"
    click PB "https://github.com/android/androidify/blob/main/benchmark/src/main/kotlin/com/android/developers/androidify/benchmark/PromptBenchmark.kt"
    click SB "https://github.com/android/androidify/blob/main/benchmark/src/main/kotlin/com/android/developers/androidify/benchmark/StartupBenchmark.kt"

    %% Class Definitions
    classDef app fill:#D8BFD8,stroke:#9370DB,stroke-width:2px
    classDef feature fill:#ADD8E6,stroke:#00008B,stroke-width:1px
    classDef data fill:#FFFACD,stroke:#DAA520,stroke-width:1px
    classDef infra fill:#98FB98,stroke:#228B22,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#696969,stroke-width:1px,stroke-dasharray: 2 2
    classDef testing fill:none,stroke:#A9A9A9,stroke-dasharray: 5 5
    classDef benchmark fill:#FFDAB9,stroke:#FF8C00,stroke-width:1px
```
