# josealcerreca/android-architecture architecture

> Architecture diagram of the GitHub repository josealcerreca/android-architecture, 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/josealcerreca/android-architecture
- Repository: https://github.com/josealcerreca/android-architecture

## Overview

Based on your provided file tree and README, you’re working with an Android sample project that demonstrates modern architectural practices for Android app development. This To-Do app is built using Jetpack Compose for the UI, follows a single-activity and navigation-compose pattern, relies on ViewModels paired with reactive streams (via Flow and Coroutines), and uses Hilt for dependency injection. It also features a clearly defined data layer—with a repository that abstracts local (Room) and network (a fake remote data source) operations—and a comprehensive suite of tests (unit, integration, and end-to-end).

##### Main Components
- UI/Presentation Layer:
- Compose Screens (e.g., TasksScreen, AddEditTaskScreen, TaskDetailScreen, StatisticsScreen)
- Navigation: Single Activity with Navigation Compose, which handles screen transitions (e.g., TodoActivity, TodoNavGraph)
- ViewModels: Each screen has an associated ViewModel that manages UI state (e.g., TasksViewModel, AddEditTaskViewModel)

- Data Layer:
- Repository: Abstracts data access (e.g., DefaultTaskRepository)
- Data Sources:
▪ Local Data Source: Using Room database (e.g., ToDoDatabase, TaskDao, LocalTask)
▪ Network Data Source: A fake or simulated remote data source (e.g., NetworkTaskDataSource, NetworkDataSource)
- Model Mapping and Domain Models: Entities like Task and mapping extensions

- Dependency Injection:
- Hilt is used to inject dependencies across layers, as seen with modules such as DataModules, CoroutinesModule
- Test-specific dependency modules also exist (e.g., in the shared-test directory)

- Configuration and Build:
- Gradle build scripts, product flavors (`mock` and `prod`), and CI configurations (GitHub workflows)

- Testing:
- A broad test suite that includes unit tests for viewmodels and repository logic, integration tests for data sources, and UI tests (both instrumented and shared tests)

##### Component Relationships/Interactions
- The UI layer (Compose screens) sends user actions to its corresponding ViewModel.
- The ViewModel interacts with the repository from the data layer to fetch/update task data.
- The repository decides whether to use the local data source (Room database) or the network data source.
- Hilt mediates dependency injection, ensuring that each layer receives the proper instances without manual wiring.
- Automated tests exercise components in isolation (unit tests) or in integration (UI and shared tests).

- Separation of Concerns: Clearly distinguish between presentation (UI/Compose screens, navigation, ViewModels), business/data logic (Repository), and data sources (local and network).
- Reactive Programming: Incorporate Flow and Coroutines for asynchronous data handling.
- Modularization: Highlight the presence of shared test modules and how product flavors facilitate build variants for testing vs. production.

##### Technologies, Frameworks, and Tools
- Jetpack Compose, Navigation Compose for building and managing UI.
- Room for local storage, coupled with DAOs.
- Kotlin Coroutines and Flow for asynchronous operations.
- Hilt for dependency injection.
- Gradle for build configuration.
- Testing frameworks for unit, UI/instrumented tests, and shared tests.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI/Presentation Layer
    subgraph "UI/Presentation Layer"
        A1["Compose Screen: TasksScreen"]:::compose
        A2["Compose Screen: AddEditTaskScreen"]:::compose
        A3["Compose Screen: TaskDetailScreen"]:::compose
        A4["Compose Screen: StatisticsScreen"]:::compose
        B1["Navigation: TodoActivity"]:::nav
        B2["Navigation: TodoNavGraph"]:::nav
        C1["ViewModel: TasksViewModel"]:::viewmodel
        C2["ViewModel: AddEditTaskViewModel"]:::viewmodel
        C3["ViewModel: TaskDetailViewModel"]:::viewmodel
        C4["ViewModel: StatisticsViewModel"]:::viewmodel
    end

    %% Data Layer
    subgraph "Data Layer"
        D1["Repository: DefaultTaskRepository"]:::repository
        subgraph "Local Data Source"
            LD1["Database: ToDoDatabase"]:::database
            LD2["DAO: TaskDao"]:::database
            LD3["Model: LocalTask"]:::model
        end
        subgraph "Network Data Source"
            ND1["Interface: NetworkDataSource"]:::network
            ND2["Model: NetworkTask"]:::network
            ND3["Implementation: TaskNetworkDataSource"]:::network
        end
        E1["Model Mapping: ModelMappingExt"]:::mapping
        E2["Entity: Task"]:::mapping
    end

    %% Dependency Injection
    subgraph "Dependency Injection (Hilt)"
        F1["Hilt Module: DataModules"]:::di
        F2["Hilt Module: CoroutinesModule"]:::di
    end

    %% Testing
    subgraph "Testing"
        G1["Test: TasksViewModelTest"]:::test
        G2["Test: TasksScreenTest"]:::test
        G3["Shared Test Modules"]:::test
    end

    %% Configuration and Build
    subgraph "Configuration"
        H1["Build Scripts"]:::config
        H2["CI Configurations"]:::config
    end

    %% Relationships
    %% UI layer interactions
    A1 -->|"updates"| C1
    A2 -->|"updates"| C2
    A3 -->|"updates"| C3
    A4 -->|"updates"| C4
    B1 -->|"navigates to"| B2

    %% ViewModels to Repository
    C1 -->|"fetches/updates"| D1
    C2 -->|"fetches/updates"| D1
    C3 -->|"fetches/updates"| D1
    C4 -->|"fetches/updates"| D1

    %% Repository interacts with Data Sources
    D1 -->|"reads/writes"| LD1
    D1 -->|"reads/writes"| LD2
    D1 -->|"reads/writes"| LD3
    D1 -->|"reads/writes"| ND1
    D1 -->|"reads/writes"| ND2
    D1 -->|"reads/writes"| ND3

    %% Repository relates to Model Mapping and Domain Models
    D1 -->|"maps"| E1
    E1 -->|"converts to/from"| E2

    %% Dependency Injection provides dependencies
    F1 --> C1
    F1 --> C2
    F1 --> C3
    F1 --> C4
    F1 --> D1
    F2 --> C1
    F2 --> C2
    F2 --> C3
    F2 --> C4
    F2 --> D1

    %% Testing targets
    G1 --- C1
    G2 --- A1
    G3 --- D1

    %% Click Events for UI/Presentation Layer
    click A1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksScreen.kt"
    click A2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/addedittask/AddEditTaskScreen.kt"
    click A3 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailScreen.kt"
    click A4 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/statistics/StatisticsScreen.kt"
    click B1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/TodoActivity.kt"
    click B2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/TodoNavGraph.kt"
    click C1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModel.kt"
    click C2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/addedittask/AddEditTaskViewModel.kt"
    click C3 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/taskdetail/TaskDetailViewModel.kt"
    click C4 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/statistics/StatisticsViewModel.kt"

    %% Click Events for Data Layer
    click D1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/DefaultTaskRepository.kt"
    click E1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/ModelMappingExt.kt"
    click E2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/Task.kt"
    click LD1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/local/ToDoDatabase.kt"
    click LD2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TaskDao.kt"
    click LD3 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/local/LocalTask.kt"
    click ND1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/network/NetworkDataSource.kt"
    click ND2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/network/NetworkTask.kt"
    click ND3 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/network/TaskNetworkDataSource.kt"

    %% Click Events for Dependency Injection
    click F1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/di/DataModules.kt"
    click F2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/main/java/com/example/android/architecture/blueprints/todoapp/di/CoroutinesModule.kt"

    %% Click Events for Testing
    click G1 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/test/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModelTest.kt"
    click G2 "https://github.com/josealcerreca/android-architecture/blob/master/app/src/androidTest/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksScreenTest.kt"
    click G3 "https://github.com/josealcerreca/android-architecture/tree/master/shared-test/src/main/java/com/example/android/architecture/blueprints/todoapp/"

    %% Click Events for Configuration
    click H1 "https://github.com/josealcerreca/android-architecture/blob/master/app/build.gradle.kts"
    click H2 "https://github.com/josealcerreca/android-architecture/blob/master/.github/workflows/blueprints.yaml"

    %% Styles
    classDef compose fill:#bbdefb,stroke:#0d47a1,stroke-width:2px;
    classDef nav fill:#c8e6c9,stroke:#1b5e20,stroke-width:2px;
    classDef viewmodel fill:#ffcc80,stroke:#e65100,stroke-width:2px;
    classDef repository fill:#ffe082,stroke:#ff6f00,stroke-width:2px;
    classDef database fill:#b2dfdb,stroke:#004d40,stroke-width:2px;
    classDef model fill:#dcedc8,stroke:#33691e,stroke-width:2px;
    classDef network fill:#f8bbd0,stroke:#880e4f,stroke-width:2px;
    classDef mapping fill:#d1c4e9,stroke:#4a148c,stroke-width:2px;
    classDef di fill:#f0f4c3,stroke:#827717,stroke-width:2px;
    classDef test fill:#fff9c4,stroke:#f57f17,stroke-width:2px;
    classDef config fill:#cfd8dc,stroke:#37474f,stroke-width:2px;
```
