# droidknights/droidknightsapp architecture

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

- Interactive diagram: https://gitdiagram.com/droidknights/droidknightsapp
- Repository: https://github.com/droidknights/droidknightsapp

## Overview

##### Project type and purpose
- This is a full-stack native Android application (“DroidKnights App”) that displays conference session, speaker, sponsor, and contributor information.
- The README describes a multi-module, layered architecture (Presentation/Domain/Data) using Kotlin, Jetpack Compose, Hilt, Retrofit, DataStore, and local JSON assets for data.

##### File structure
- Top-level “app” module – the Android application entry point (MainActivity, Application class).
- “feature/*” modules – each screen or feature (home, session, contributor, bookmark, setting, main).
- “core/*” modules – shared libraries:
- core/ui, core/designsystem, core/navigation (UI primitives, Compose theming, navigation model)
- core/model (shared data models)
- core/domain (use-case definitions)
- core/data-api (repository interfaces)
- core/data (implementations using Retrofit & local JSON assets)
- core/datastore (DataStore for user preferences)
- core/testing + ui-test-hilt-manifest (test utilities and Hilt test harness)
- “widget” – home-screen App Widget using the same domain/data layers.
- “build-logic” – custom Gradle plugin modules for consistent build configuration.
- CI/CD workflows under .github (unit tests, screenshots, releases).

##### README for additional insights
- Unidirectional data flow in UI: UI emits events up; state flows down from ViewModel
- Multi-module graph generated via Gradle + GraphViz

##### Elements
- App & Feature modules
- core/ui, core/designsystem, core/navigation
- core/domain, core/data-api, core/data, core/datastore
- External REST API, Local JSON Assets
- Widget module
- build-logic (build script plugin)
- UseCase → Repository → DataSource → External/Assets/DataStore
- Blue for Presentation
- Green for Domain
- Orange for Data
- Grey for Infrastructure (build-logic, CI/CD, external API)
- Labels:
- Module names, classes (e.g., BookmarkViewModel, GetSessionsUseCase, DefaultSessionRepository), data flows (JSON, Retrofit)

## Diagram (Mermaid)

```mermaid
flowchart TB
  %% Presentation Layer
  subgraph "Presentation Layer" 
    direction TB
    App["DroidKnightsApplication"]:::presentation
    subgraph Features
      direction TB
      Main["MainActivity"]:::presentation
      Home["HomeScreen"]:::presentation
      Session["SessionScreen"]:::presentation
      Contributor["ContributorScreen"]:::presentation
      Bookmark["BookmarkScreen"]:::presentation
      Setting["SettingScreen"]:::presentation
    end
    UI["core/ui"]:::presentation
    Design["core/designsystem"]:::presentation
    Nav["core/navigation"]:::presentation
    Widget["DroidKnightsWidget"]:::presentation
  end

  %% Domain Layer
  subgraph "Domain Layer"
    direction TB
    UseCase["GetSessionsUseCase"]:::domain
  end

  %% Data Layer
  subgraph "Data Layer"
    direction TB
    RepoIface["SessionRepository (interface)"]:::data
    RepoImpl["DefaultSessionRepository"]:::data
    Assets["Local JSON Assets"]:::data
    DS["DefaultSessionPreferencesDataSource"]:::data
    API["External REST API"]:::infra
  end

  %% Infrastructure Layer
  subgraph "Infrastructure"
    direction TB
    BuildLogic["build-logic"]:::infra
    CICD["CI/CD Workflows"]:::infra
  end

  %% Dependencies
  Main -->|uses| UI
  Main -->|uses| Design
  Main -->|uses| Nav
  Home -->|events→| UseCase
  Session -->|events→| UseCase
  Contributor -->|events→| UseCase
  Bookmark -->|events→| UseCase
  Setting -->|events→| UseCase
  Widget -->|events→| UseCase

  UI -->|depends on| App
  Design -->|depends on| App
  Nav -->|depends on| App

  UseCase -->|calls| RepoIface
  RepoIface -->|implemented by| RepoImpl
  RepoImpl -->|fetches from| API
  RepoImpl -->|reads| Assets
  RepoImpl -->|reads/writes| DS

  App -->|Hilt provides| UseCase
  App -->|Hilt binds| RepoIface-->RepoImpl
  App -->|Hilt provides| DS
  App -->|Hilt provides| API

  BuildLogic -.-> App
  CICD -.-> App

  %% Click Events
  click App "https://github.com/droidknights/droidknightsapp/blob/main/app/src/main/java/com/droidknights/app/DroidKnightsApplication.kt"
  click Main "https://github.com/droidknights/droidknightsapp/blob/main/feature/main/src/main/java/com/droidknights/app/feature/main/MainActivity.kt"
  click Home "https://github.com/droidknights/droidknightsapp/blob/main/feature/home/src/main/java/com/droidknights/app/feature/home/HomeScreen.kt"
  click Session "https://github.com/droidknights/droidknightsapp/blob/main/feature/session/src/main/java/com/droidknights/app/feature/session/SessionScreen.kt"
  click Contributor "https://github.com/droidknights/droidknightsapp/blob/main/feature/contributor/src/main/java/com/droidknights/app/feature/contributor/ContributorScreen.kt"
  click Bookmark "https://github.com/droidknights/droidknightsapp/blob/main/feature/bookmark/src/main/java/com/droidknights/app/feature/bookmark/BookmarkScreen.kt"
  click Setting "https://github.com/droidknights/droidknightsapp/blob/main/feature/setting/src/main/java/com/droidknights/app/feature/setting/SettingScreen.kt"
  click UI "https://github.com/droidknights/droidknightsapp/blob/main/core/ui/src/main/java/com/droidknights/app/core/ui/RoomText.kt"
  click Design "https://github.com/droidknights/droidknightsapp/blob/main/core/designsystem/src/main/java/com/droidknights/app/core/designsystem/theme/Theme.kt"
  click Nav "https://github.com/droidknights/droidknightsapp/blob/main/core/navigation/src/main/java/com/droidknights/app/core/navigation/RouteModel.kt"
  click UseCase "https://github.com/droidknights/droidknightsapp/blob/main/core/domain/src/main/java/com/droidknights/app/core/domain/usecase/GetSessionsUseCase.kt"
  click RepoIface "https://github.com/droidknights/droidknightsapp/blob/main/core/data-api/src/main/java/com/droidknights/app/core/data/repository/api/SessionRepository.kt"
  click RepoImpl "https://github.com/droidknights/droidknightsapp/blob/main/core/data/src/main/java/com/droidknights/app/core/data/repository/DefaultSessionRepository.kt"
  click Assets "https://github.com/droidknights/droidknightsapp/blob/main/core/data/src/main/assets/sessions.json"
  click DS "https://github.com/droidknights/droidknightsapp/blob/main/core/datastore/src/main/java/com/droidknights/app/core/datastore/datasource/DefaultSessionPreferencesDataSource.kt"
  click Widget "https://github.com/droidknights/droidknightsapp/blob/main/widget/src/main/kotlin/com/droidknights/app/widget/DroidKnightsWidget.kt"
  click BuildLogic "https://github.com/droidknights/droidknightsapp/blob/main/build-logic/src/main/kotlin/com/droidknights/app/HiltAndroid.kt"
  click CICD "https://github.com/droidknights/droidknightsapp/blob/main/.github/workflows/android-pull-request-ci.yml"

  %% Styles
  classDef presentation fill:#bbdefb,stroke:#0d47a1,color:#0d47a1
  classDef domain fill:#c8e6c9,stroke:#1b5e20,color:#1b5e20
  classDef data fill:#ffe0b2,stroke:#e65100,color:#e65100
  classDef infra fill:#e0e0e0,stroke:#424242,color:#424242
```
