# hoseinsadonasl/minigallery architecture

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

- Interactive diagram: https://gitdiagram.com/hoseinsadonasl/minigallery
- Repository: https://github.com/hoseinsadonasl/minigallery

## Overview

##### Project Type & Purpose
- The project is an open-source Android application written completely in Kotlin.
- It showcases modern Android development using Jetpack Compose for building responsive UIs and follows Clean Architecture along with the Model-View-Intent (MVI) presentation pattern.
- The modular design is evident from the directory structure which splits functionality (features, core, media, etc.) into separate modules for better separation of concerns and maintainability.

##### File Structure
- The top-level directories include:
– "app": The entry point of the Android application containing MainActivity, the application class, and primary resources.
– "build-logic": Modules containing Gradle convention plugins and scripts that set consistent build standards.
– "core", "core-feature", "media", and "features": Indicate a modular architecture; for example:
∙ "core-domain", "core-database", and "core-datastore" define business logic, data persistence, and app settings.
∙ "features" folder contains modules like “albums”, “media-library”, “media”, “media-details”, and “onboarding” that represent specific application functionalities.
∙ "core-feature" holds shared design elements (“designsystem”, “navigation”, “ui”) crucial to the UI and user flows.
- There are separate modules for data sources and repositories (e.g., media-data, media-datasource, media-domain) which follow Clean Architecture by segregating data access, domain logic, and presentation concerns.

##### Main Components
a. Presentation Layer:
– App Module: Contains MainActivity, UI components, and the application class (MiniGalleryApp.kt).
– Feature Modules: Each feature (albums, media-library, media, media-details, onboarding) includes its own screens (with Compose based UI), ViewModels, and state/event classes. The MVI pattern ensures a unidirectional flow of data.
– Core UI and Navigation: Under “core-feature/navigation” and “core-feature/ui”, these components manage screen transitions, shared UI components, and consistent theming/design.

b. Domain Layer:
– Modules under "core/domain" and "media/media-domain" encapsulate business logic and use cases (such as GetAlbumsUseCase, SyncMediaUseCase, FavoriteMediaUseCase) that enforce Clean Architecture principles.
– These interact with the repositories abstracting the data layer.

c. Data Layer:
– Data handling is split mainly between "core/database", "core/datastore", and “media-data”/ “media-datasource”.
∙ The database module manages local persistence with Room (or similar) and provides DAOs.
∙ The datastore module stores user preferences or application settings.
∙ Media data and repository implementations handle network or content provider data with dedicated mappers to transform data between representations.

d. Build & Configuration:
– "build-logic" and Gradle configuration files standardize the build and dependency management.
– These are supportive components that enforce code quality (using Ktlint, Detekt) and modular build conventions.

##### Representing Relationships & Data Flow
– The Presentation layer (UI, Screens, ViewModels) communicates with the Domain layer through use cases.
– The Domain layer interacts with the Data layer via abstracted repository interfaces.
- That dependency injection (using Hilt) is used across modules to manage dependencies.
- Unidirectional flow inherent in MVI: user events lead to updates in state, which update the UI.

##### Architectural Patterns & Design Principles
- Modular Design: Show how each module (feature-specific or core shared modules) encapsulates related functionality.
- MVI Pattern: In the presentation modules, annotate state, intents (events), and the view layer, showcasing the unidirectional data flow.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        A["App Module"]:::presentation
        F1["Feature Module - Albums"]:::presentation
        F2["Feature Module - Media Library"]:::presentation
        F3["Feature Module - Media"]:::presentation
        F4["Feature Module - Media Details"]:::presentation
        F5["Feature Module - Onboarding"]:::presentation
        C1["Core DesignSystem"]:::presentation
        C2["Core Navigation"]:::presentation
        C3["Core UI"]:::presentation
    end

    %% Domain Layer
    subgraph "Domain Layer"
        D1["Domain Layer - Core Domain"]:::domain
        D2["Domain Layer - Media Domain"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        DT1["Database Module"]:::data
        DT2["Datastore Module"]:::data
        DT3["Media Data Module"]:::data
        DT4["Media Datasource Module"]:::data
    end

    %% Build & Configuration
    subgraph "Build & Configuration"
        B["Build & Configuration"]:::build
    end

    %% Inter-layer Relationships
    %% Presentation -> Domain (Invokes Use Cases via MVI)
    A -->|"invokes_use_case"| D1
    F1 -->|"invokes_use_case"| D1
    F2 -->|"invokes_use_case"| D2
    F3 -->|"invokes_use_case"| D2
    F4 -->|"invokes_use_case"| D2
    F5 -->|"invokes_use_case"| D2

    %% Domain -> Data (Repository and Data Fetching)
    D1 -->|"calls_repository"| DT1
    D1 -->|"retrieves_settings"| DT2
    D2 -->|"maps_and_fetches"| DT3
    D2 -->|"fetches_details"| DT4

    %% Build & Configuration applies to layers
    B -->|"build_conventions"| A
    B -->|"build_conventions"| D1
    B -->|"build_conventions"| DT1

    %% Dependency Injection as the glue (using Hilt)
    A ---|"DI_using_Hilt"| D1
    D1 ---|"DI_using_Hilt"| DT1

    %% Styles
    classDef presentation fill:#bbdefb,stroke:#0d47a1,stroke-width:2px,color:black;
    classDef domain fill:#c8e6c9,stroke:#1b5e20,stroke-width:2px,color:black;
    classDef data fill:#ffe0b2,stroke:#e65100,stroke-width:2px,color:black;
    classDef build fill:#d1c4e9,stroke:#673ab7,stroke-width:2px,color:black;

    %% Click Events
    click A "https://github.com/hoseinsadonasl/minigallery/tree/develop/app/src/main/java/com/hotaku/minigallery"
    click F1 "https://github.com/hoseinsadonasl/minigallery/tree/develop/features/albums"
    click F2 "https://github.com/hoseinsadonasl/minigallery/tree/develop/features/media-library"
    click F3 "https://github.com/hoseinsadonasl/minigallery/tree/develop/features/media"
    click F4 "https://github.com/hoseinsadonasl/minigallery/tree/develop/features/media_details"
    click F5 "https://github.com/hoseinsadonasl/minigallery/tree/develop/features/onboarding"
    click C1 "https://github.com/hoseinsadonasl/minigallery/tree/develop/core-feature/designsystem"
    click C2 "https://github.com/hoseinsadonasl/minigallery/tree/develop/core-feature/navigation"
    click C3 "https://github.com/hoseinsadonasl/minigallery/tree/develop/core-feature/ui"
    click D1 "https://github.com/hoseinsadonasl/minigallery/tree/develop/core/domain"
    click D2 "https://github.com/hoseinsadonasl/minigallery/tree/develop/media/media-domain"
    click DT1 "https://github.com/hoseinsadonasl/minigallery/tree/develop/core/database"
    click DT2 "https://github.com/hoseinsadonasl/minigallery/tree/develop/core/datastore"
    click DT3 "https://github.com/hoseinsadonasl/minigallery/tree/develop/media/media-data"
    click DT4 "https://github.com/hoseinsadonasl/minigallery/tree/develop/media/media-datasource"
    click B "https://github.com/hoseinsadonasl/minigallery/tree/develop/build-logic"
```
