# aconinc/acon-android architecture

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

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

## Overview

##### Project Type & Purpose
- Type: Android mobile application
- Purpose: A location-based “No more research” map app that allows users to sign in, onboard (preference selection), explore spots, verify local area, upload new spots, view & edit profile, and configure settings.
- Key Patterns: Single-Activity (Jetpack Navigation), Clean Architecture, MVI (Orbit), Multi-module Gradle.

##### High-Level Architectural Layers

Presentation (UI & State):
– App Module: Single Activity, Hilt setup, Nav graphs
– Feature Modules (signin, onboarding, spot, areaverification, upload, profile, settings):
- Composable Screens (UI)
- Orbit ViewModels (State + Side-Effects + Intents)
– Core/DesignSystem Module: shared UI components, theming

Domain (Business Logic):
– Domain Module:
- UseCases (if present)
- Repository interfaces
- Domain Models & Error types

Data (Data Delivery):
– Data Module:
- RepositoryImpls (implements Domain repos)
- Remote DataSources (Retrofit APIs)
- Local DataSources (DataStore / SharedPreferences)
- DTOs (request/response)
- Hilt Network + Auth Modules

Core Utility Modules:
– core/common (qualifiers, dispatchers)
– core/map (map utility logic)
– core/utils/feature (permissions, back-press, toast)

External Services:
– REST APIs (Auth, Onboarding, Profile, Spot, Upload, Area Verification, Map)
– Amplitude analytics
– GitHub Actions CI/CD
– Hilt DI, Retrofit/OkHttp, Coroutines/Flow, Coil image loader

##### Components & Relationships
- UI → ViewModel: user events trigger Orbit intents
- ViewModel → Domain → Repository interface
- RepositoryImpl → DataSource:
– If remote: Retrofit API → JSON DTO → Domain Model
– If local: DataStore → key-value storage → Domain Model
- ViewModel collects Flows from UseCases/Repositories → updates UI state
- Navigation: NavController in App Module orchestrates feature Graphs
- Shared DesignSystem: reused by all feature UIs

##### Architectural Patterns & Design Principles
- Single-Activity / Jetpack Navigation with nested graphs per feature
- Multi-module separation:
– core (UI components, utils)
– data (infrastructure)
– domain (pure business)
– feature (presentation + state)
- Clean-Architecture: clear dependency direction (UI → Domain → Data)
- MVI (Orbit): deterministic, unidirectional data flow

1. App Module → Feature Modules (navigation host)
2. Feature UI → Feature ViewModel
3. ViewModel → Domain (Repository interfaces / UseCases)
4. Domain → Data (RepositoryImpl)
5. Data → Remote APIs / Local DataStores
6. Feature & Data → Core Modules where applicable
– Show external services on the right: REST endpoints, Amplitude, CI

##### Detail Level
– Capture navigation flows between features.
– Explicitly show DI graph entry points (Application → Hilt Modules → Injected repos).
– Show state flow: UI → Intent → State → UI

## Diagram (Mermaid)

```mermaid
graph TB
    %% Presentation Layer
    subgraph "Presentation" 
        direction TB
        AconApplication["AconApplication"]:::presentation
        MainActivity["MainActivity"]:::presentation
        Navigation["Nav Graphs"]:::presentation
        Feature_SignIn["Feature: SignIn\n(UI Screens & ViewModels)"]:::presentation
        Feature_Onboarding["Feature: Onboarding\n(UI Screens & ViewModels)"]:::presentation
        Feature_Spot["Feature: Spot\n(UI Screens & ViewModels)"]:::presentation
        Feature_AreaVerification["Feature: AreaVerification\n(UI Screens & ViewModel)"]:::presentation
        Feature_Upload["Feature: Upload\n(UI Screens & ViewModel)"]:::presentation
        Feature_Profile["Feature: Profile\n(UI Screens & ViewModel)"]:::presentation
        Feature_Settings["Feature: Settings\n(UI Screens & ViewModel)"]:::presentation
    end

    %% Core Modules
    subgraph "Core Modules" 
        direction TB
        subgraph "core/common" 
            AuthQualifiers["AuthQualifiers"]:::core
            DispatcherQualifiers["DispatcherQualifiers"]:::core
        end
        DesignSystem["DesignSystem\n(shared UI & theming)"]:::core
        MapUtils["MapUtils"]:::core
        UtilsFeature["Utils/Feature\n(permissions, back-press, toast)"]:::core
    end

    %% Domain Layer
    subgraph "Domain" 
        DomainModule["Domain\n(UseCases, Models, Repos Interfaces)"]:::domain
    end

    %% Data Layer
    subgraph "Data"
        direction TB
        DataSources["DataSources\n(remote & local)"]:::data
        DTOs["DTOs"]:::data
        RemoteAPIs["Remote APIs\n(Retrofit Interfaces)"]:::data
        DIModules["DI Modules\n(ApiModule, NetworkModule, RepositoryModule)"]:::data
        RepoImpl["RepositoryImpls"]:::data
        SessionManager["SessionManager"]:::data
    end

    %% External Services
    subgraph "External Services"
        REST["REST Endpoints\n(Auth, Onboarding, Spot, Map, etc.)"]:::external
        Amplitude["Amplitude Analytics"]:::external
        CI["GitHub Actions CI/CD"]:::external
    end

    %% Relationships
    AconApplication -->|navigation host| Navigation
    AconApplication -->|injects| DIModules
    Navigation --> Feature_SignIn
    Navigation --> Feature_Onboarding
    Navigation --> Feature_Spot
    Navigation --> Feature_AreaVerification
    Navigation --> Feature_Upload
    Navigation --> Feature_Profile
    Navigation --> Feature_Settings

    Feature_SignIn -->|Orbit MVI Intents| DomainModule
    Feature_Onboarding -->|Orbit MVI Intents| DomainModule
    Feature_Spot -->|Orbit MVI Intents| DomainModule
    Feature_AreaVerification -->|Orbit MVI Intents| DomainModule
    Feature_Upload -->|Orbit MVI Intents| DomainModule
    Feature_Profile -->|Orbit MVI Intents| DomainModule
    Feature_Settings -->|Orbit MVI Intents| DomainModule

    DomainModule -->|calls| RepoImpl
    RepoImpl -->|uses| RemoteAPIs
    RepoImpl -->|uses| DataSources
    RemoteAPIs -->|Retrofit + OkHttp| REST
    DataSources -->|DataStore| SessionManager

    Feature_SignIn -->|uses| DesignSystem
    Feature_Onboarding -->|uses| DesignSystem
    Feature_Spot -->|uses| DesignSystem
    Feature_AreaVerification -->|uses| DesignSystem
    Feature_Upload -->|uses| DesignSystem
    Feature_Profile -->|uses| DesignSystem
    Feature_Settings -->|uses| DesignSystem

    DomainModule -->|uses| AuthQualifiers
    RepoImpl -->|uses| DispatcherQualifiers
    RepoImpl -->|uses| UtilsFeature
    RepoImpl -->|uses| MapUtils

    REST --> Amplitude
    CI -->|triggers| DIModules

    %% Click events
    click AconApplication "https://github.com/aconinc/acon-android/blob/develop/app/src/main/java/com/acon/acon/AconApplication.kt"
    click MainActivity "https://github.com/aconinc/acon-android/blob/develop/app/src/main/java/com/acon/acon/MainActivity.kt"
    click Navigation "https://github.com/aconinc/acon-android/tree/develop/app/src/main/java/com/acon/acon/navigation"
    click AuthQualifiers "https://github.com/aconinc/acon-android/blob/develop/core/common/src/main/java/com/acon/acon/core/common/AuthQualifiers.kt"
    click DispatcherQualifiers "https://github.com/aconinc/acon-android/blob/develop/core/common/src/main/java/com/acon/acon/core/common/DispatcherQualifiers.kt"
    click DesignSystem "https://github.com/aconinc/acon-android/tree/develop/core/designsystem/src/main/java/com/acon/acon/core/designsystem"
    click MapUtils "https://github.com/aconinc/acon-android/blob/develop/core/map/src/main/java/com/acon/acon/core/map/MapUtils.kt"
    click UtilsFeature "https://github.com/aconinc/acon-android/tree/develop/core/utils/feature/src/main/java/com/acon/acon/core/utils/feature"
    click DomainModule "https://github.com/aconinc/acon-android/tree/develop/domain/src/main/java/com/acon/acon/domain"
    click DataSources "https://github.com/aconinc/acon-android/tree/develop/data/src/main/kotlin/com/acon/acon/data/datasource"
    click DTOs "https://github.com/aconinc/acon-android/tree/develop/data/src/main/kotlin/com/acon/acon/data/dto"
    click RemoteAPIs "https://github.com/aconinc/acon-android/tree/develop/data/src/main/kotlin/com/acon/acon/data/remote"
    click DIModules "https://github.com/aconinc/acon-android/blob/develop/data/src/main/kotlin/com/acon/acon/data/di/ApiModule.kt"
    click RepoImpl "https://github.com/aconinc/acon-android/tree/develop/data/src/main/kotlin/com/acon/acon/data/repository"
    click SessionManager "https://github.com/aconinc/acon-android/blob/develop/data/src/main/kotlin/com/acon/acon/data/SessionManager.kt"
    click Feature_SignIn "https://github.com/aconinc/acon-android/tree/develop/feature/signin/src/main/java/com/acon/acon/feature/signin"
    click Feature_Onboarding "https://github.com/aconinc/acon-android/tree/develop/feature/onboarding/src/main/java/com/acon/acon/feature/onboarding"
    click Feature_Spot "https://github.com/aconinc/acon-android/tree/develop/feature/spot/src/main/java/com/acon/acon/feature/spot"
    click Feature_AreaVerification "https://github.com/aconinc/acon-android/tree/develop/feature/areaverification/src/main/java/com/acon/acon/feature/areaverification"
    click Feature_Upload "https://github.com/aconinc/acon-android/tree/develop/feature/upload/src/main/java/com/acon/acon/feature/upload"
    click Feature_Profile "https://github.com/aconinc/acon-android/tree/develop/feature/profile/src/main/java/com/acon/acon/feature/profile"
    click Feature_Settings "https://github.com/aconinc/acon-android/tree/develop/feature/settings/src/main/java/com/acon/acon/feature/settings"

    %% Styles
    classDef presentation fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef core fill:#F0F0F0,stroke:#606060,color:#303030
    classDef domain fill:#DFFFE0,stroke:#28A745,color:#28A745
    classDef data fill:#FFF0D0,stroke:#D97706,color:#D97706
    classDef external fill:#FFE0E0,stroke:#D73A49,color:#D73A49
```
