# google-developer-training/basic-android-kotlin-compose-training-amphibians architecture

> Architecture diagram of the GitHub repository google-developer-training/basic-android-kotlin-compose-training-amphibians, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/google-developer-training/basic-android-kotlin-compose-training-amphibians
- Repository: https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians

## Overview

##### Main Components (Folders)
- App Module (app): This is the heart of the project.
- Source Code Hierarchy:
- /src/main/java/com/example/amphibians contains the core packages:
- Application Class (AmphibiansApplication.kt)
- MainActivity.kt for launching the UI
- /data folder: Contains the repository (AmphibiansRepository.kt) and AppContainer.kt (acts as the dependency injection/lightweight service locator).
- /model folder: Contains data models like Amphibian.kt.
- /network folder: Contains the Retrofit-based API service (AmphibiansApiService.kt) for fetching data from the internet.
- /ui folder: Contains the composable application (AmphibiansApp.kt), screens (including HomeScreen.kt), and ViewModels (AmphibiansViewModel.kt).
- Resource files (res folders): Maintain layouts (drawables, values, and mipmaps) needed for rendering UI components.
- Build System and Configurations:
- Gradle files (build.gradle.kts, settings.gradle.kts) and the wrapper ensure a repeatable build environment.
- GitHub workflows and configuration files (*.github folder) indicate CI/CD practices.

##### Relationships and Interactions
- UI Layer: The UI is built using Compose with the AmphibiansApp entry point, which launches the HomeScreen.
- ViewModel Layer: HomeScreen communicates with AmphibiansViewModel for business logic and state management.
- Data Layer: The AmphibiansViewModel depends on AmphibiansRepository (via AppContainer for dependency management) to fetch and provide data.
- Network: The AmphibiansRepository uses AmphibiansApiService (a Retrofit-based API client) to perform network calls.
- Model: The Amphibian data model is used across the repository and UI layers to define the data structure.

##### Architectural Patterns and Design Principles
- MVVM: Clear separation between UI (compose screens), business logic (ViewModel), and data (repository, network services).
- Dependency Injection: The AppContainer in the data package provides a simple DI mechanism.
- Use of Retrofit and Coil: Indicates pattern-driven integration where network calls and resource loading are abstracted via dedicated libraries.
- Layering: Separate folders clearly show segregation between UI, network, and business logic.

## Diagram (Mermaid)

```mermaid
flowchart TD
    AppModule("App Module"):::android
    click AppModule "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/tree/main/app"

    subgraph "Source Code: app/src/main/java/com/example/amphibians"
        subgraph "Application Layer"
            AA("AmphibiansApplication.kt"):::android
            click AA "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/AmphibiansApplication.kt"
            MA("MainActivity.kt"):::android
            click MA "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/MainActivity.kt"
        end
        subgraph "Data Layer"
            REP("AmphibiansRepository.kt"):::data
            click REP "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/data/AmphibiansRepository.kt"
            AC("AppContainer.kt"):::data
            click AC "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/data/AppContainer.kt"
        end
        subgraph "Model Layer"
            M("Amphibian.kt"):::model
            click M "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/model/Amphibian.kt"
        end
        subgraph "Network Layer"
            API("AmphibiansApiService.kt"):::network
            click API "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/network/AmphibiansApiService.kt"
        end
        subgraph "UI Layer"
            UIApp("AmphibiansApp.kt"):::ui
            click UIApp "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/ui/AmphibiansApp.kt"
            subgraph "Screens & ViewModel"
                HS("HomeScreen.kt"):::ui
                click HS "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/ui/screens/HomeScreen.kt"
                VM("AmphibiansViewModel.kt"):::business
                click VM "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/src/main/java/com/example/amphibians/ui/screens/AmphibiansViewModel.kt"
            end
            subgraph "Theme"
                Theme("ui/theme"):::theme
                click Theme "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/tree/main/app/src/main/java/com/example/amphibians/ui/theme"
            end
        end
    end

    subgraph "Resources"
        RES("res"):::resource
        click RES "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/tree/main/app/src/main/res"
    end

    subgraph "Build & Config"
        Gradle("build.gradle.kts"):::build
        click Gradle "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/app/build.gradle.kts"
        ProjGradle("Project Gradle: build.gradle.kts & settings.gradle.kts"):::build
        click ProjGradle "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/build.gradle.kts"
        GitHub(".github"):::cicd
        click GitHub "https://github.com/google-developer-training/basic-android-kotlin-compose-training-amphibians/blob/main/.github"
    end

    %% Connections within Source Code
    AA -->|"launches"| MA
    MA -->|"starts"| UIApp
    UIApp -->|"loads"| HS
    HS -->|"invokes"| VM
    VM -->|"fetches from"| REP
    AC -->|"provides(dep.)"| REP
    REP -->|"calls"| API
    REP -->|"uses model"| M

    %% Connections from module to resources and build
    AppModule -->|"contains"| RES
    AppModule -->|"configured by"| Gradle
    AppModule -->|"CI/CD via"| GitHub

    %% Styles
    classDef android fill:#CEF6F5,stroke:#000,stroke-width:2px;
    classDef data fill:#F6CECE,stroke:#000,stroke-width:2px;
    classDef model fill:#D5F5E3,stroke:#000,stroke-width:2px;
    classDef network fill:#F9E79F,stroke:#000,stroke-width:2px;
    classDef ui fill:#D6EAF8,stroke:#000,stroke-width:2px;
    classDef business fill:#E8DAEF,stroke:#000,stroke-width:2px;
    classDef theme fill:#FAD7A0,stroke:#000,stroke-width:2px;
    classDef resource fill:#F0F3F4,stroke:#000,stroke-width:2px;
    classDef build fill:#D7BDE2,stroke:#000,stroke-width:2px;
    classDef cicd fill:#F5CBA7,stroke:#000,stroke-width:2px;
```
