# matheus-miranda/run-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/matheus-miranda/run-tracker
- Repository: https://github.com/matheus-miranda/run-tracker

## Overview

##### Project type and purpose
- This is a fully modularized Android application ("RunTracker") implementing a Clean (on-device) architecture.
- Purpose:
- User authentication (Register, Login)
- Run tracking (start, pause, resume, finish runs; collect GPS data; sync runs)
- Analytics dashboard (aggregate run metrics).

##### File structure
- Top-level modules:
- app – the Android application host, navigation, DI wiring, theme setup
- auth, run, analytics – each split into data, domain, presentation sub-modules
- core – shared code (data, database, domain, presentation/design system, UI helpers)
- build-logic – custom Gradle convention plugins
- Pattern: each feature follows a layered Clean Architecture:
presentation → domain → data
- Data modules use Room (core/database) and Ktor HTTP client (run/network, core/data/networking). Run/data also uses WorkManager (CreateRunWorker, FetchRunsWorker, etc.)
- DI modules in each layer (…/di/…Module.kt).

##### README for additional insights
- UI flows: Home, Register, Login, New Run, Running, Paused, Resumed, Finished, Analytics
- Confirms three main feature areas: authentication, running, analytics.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% App Module
    subgraph "App Host"
        direction TB
        App["App Module"]:::app
    end

    %% Feature Modules
    subgraph "Auth Feature"
        direction TB
        AuthPres["auth-presentation"]:::presentation
        AuthDom["auth-domain"]:::domain
        AuthData["auth-data"]:::data
    end

    subgraph "Run Feature"
        direction TB
        RunPres["run-presentation"]:::presentation
        RunDom["run-domain"]:::domain
        subgraph "run-data"
            direction TB
            RunData["run-data"]:::data
            Work["WorkManager Workers"]:::worker
        end
        RunLoc["run-location"]:::data
        RunNet["run-network"]:::data
    end

    subgraph "Analytics Feature"
        direction TB
        AnalyticsPres["analytics-presentation"]:::presentation
        AnalyticsDom["analytics-domain"]:::domain
        AnalyticsData["analytics-data"]:::data
    end

    %% Core Modules
    subgraph "Core Modules"
        direction TB
        CorePresDS["core-presentation: Design System"]:::core
        CorePresUI["core-presentation: UI Helpers"]:::core
        CoreDom["core-domain"]:::core
        CoreData["core-data"]:::core
        CoreDB["core-database"]:::core
    end

    %% Build Logic
    Build["build-logic (Gradle Plugins)"]:::core

    %% External Services
    REST["REST API Backend"]:::external
    GPS["GPS Sensor (Android Location)"]:::external

    %% Connections
    App -->|"navigates to"| AuthPres
    App -->|"navigates to"| RunPres
    App -->|"navigates to"| AnalyticsPres

    %% Auth flow
    AuthPres -->|"calls use-cases"| AuthDom
    AuthDom -->|"repo impl"| AuthData
    AuthData -->|"Room DAOs"| CoreDB
    AuthData -->|"HTTP client"| CoreData

    %% Run flow
    RunPres -->|"calls use-cases"| RunDom
    RunDom -->|"repo impl"| RunData
    RunData -->|"uses DAOs"| CoreDB
    RunData -->|"uses HTTP client"| CoreData
    RunData -->|"schedules sync"| Work
    Work -->|"triggers repos"| RunDom
    RunLoc -->|"provides location"| RunDom
    RunNet -->|"HTTP client"| CoreData
    RunPres -->|"uses UI comps"| CorePresUI

    %% Analytics flow
    AnalyticsPres -->|"calls use-cases"| AnalyticsDom
    AnalyticsDom -->|"repo impl"| AnalyticsData
    AnalyticsData -->|"uses DAOs"| CoreDB
    AnalyticsData -->|"uses HTTP client"| CoreData
    AnalyticsPres -->|"uses UI comps"| CorePresDS

    %% Core shared usage
    AuthPres -->|"uses UI comps"| CorePresUI
    RunPres -->|"uses UI comps"| CorePresUI
    AnalyticsPres -->|"uses UI comps"| CorePresUI
    CoreData -->|"HTTP to"| REST

    %% External connections
    GPS -->|"feeds"| RunLoc
    REST -->|"serves"| CoreData

    %% Build logic unattached
    Build

    %% Click Events
    click App "https://github.com/matheus-miranda/run-tracker/tree/master/app/"
    click AuthPres "https://github.com/matheus-miranda/run-tracker/tree/master/auth/presentation/"
    click AuthDom "https://github.com/matheus-miranda/run-tracker/tree/master/auth/domain/"
    click AuthData "https://github.com/matheus-miranda/run-tracker/tree/master/auth/data/"
    click RunPres "https://github.com/matheus-miranda/run-tracker/tree/master/run/presentation/"
    click RunDom "https://github.com/matheus-miranda/run-tracker/tree/master/run/domain/"
    click RunData "https://github.com/matheus-miranda/run-tracker/tree/master/run/data/"
    click RunLoc "https://github.com/matheus-miranda/run-tracker/tree/master/run/location/"
    click RunNet "https://github.com/matheus-miranda/run-tracker/tree/master/run/network/"
    click AnalyticsPres "https://github.com/matheus-miranda/run-tracker/tree/master/analytics/presentation/"
    click AnalyticsDom "https://github.com/matheus-miranda/run-tracker/tree/master/analytics/domain/"
    click AnalyticsData "https://github.com/matheus-miranda/run-tracker/tree/master/analytics/data/"
    click CorePresDS "https://github.com/matheus-miranda/run-tracker/tree/master/core/presentation/designsystem/"
    click CorePresUI "https://github.com/matheus-miranda/run-tracker/tree/master/core/presentation/ui/"
    click CoreDom "https://github.com/matheus-miranda/run-tracker/tree/master/core/domain/"
    click CoreData "https://github.com/matheus-miranda/run-tracker/tree/master/core/data/"
    click CoreDB "https://github.com/matheus-miranda/run-tracker/tree/master/core/database/"
    click Build "https://github.com/matheus-miranda/run-tracker/tree/master/build-logic/convention/"

    %% Styles
    classDef presentation fill:#AED6F1,stroke:#21618C,color:#1B4F72
    classDef domain fill:#ABEBC6,stroke:#1D8348,color:#145A32
    classDef data fill:#F9E79F,stroke:#B7950B,color:#7D6608
    classDef core fill:#D5D8DC,stroke:#909497,color:#515A5A
    classDef external fill:#F5B7B1,stroke:#C0392B,color:#78281F
    classDef app fill:#D6EAF8,stroke:#2980B9,color:#1B2631
    classDef worker fill:#FAD7A0,stroke:#CA6F1E,color:#784212
```
