# joperor/kotlin_onboarding_introduction architecture

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

- Interactive diagram: https://gitdiagram.com/joperor/kotlin_onboarding_introduction
- Repository: https://github.com/joperor/kotlin_onboarding_introduction

## Overview

##### Project Type & Purpose
- This is a Kotlin-based, multi-module “course” repository.
- Each top-level folder (AlmostDone, Chat, FeedbackSurvey, Hangman, Introduction, LastPush, MastermindAdvanced, TheFirstDateWithProgramming, WarmUp) is a self-contained lesson/task module.
- The utils module provides shared code (Util.kt, Variable.kt) and resources (images).
- Gradle (Kotlin DSL) orchestrates builds, compilation, testing and packaging across all modules.

##### Key Components
- Root Build System
– settings.gradle.kts: defines included subprojects
– build.gradle.kts (root): common plugin/dependency versions
– gradle/ & gradlew(.bat): wrapper files
- Lesson Modules (e.g. Hangman, WarmUp, …)
– task-info.yaml, lesson-info.yaml, task.md: metadata for the learning platform
– src/main/kotlin: Kotlin source under package jetbrains.kotlin.course.<module>
– src/test or task/test: unit tests for the module
– build/, out/: Gradle build artifacts
- utils Module
– src/main/kotlin/util: shared helpers
– src/main/resources/images: shared images for lessons
– build.gradle.kts: compiles to utils.jar

##### Relationships & Interactions
- Root Build System → All Modules
– Orchestrates compileKotlin, compileTestKotlin, test, jar tasks in each subproject.
- Lesson Modules → utils
– Each module declares a compile-time dependency on the utils JAR.
- Lesson Modules ↔ Their Tests
– Source files feed into unit tests located under test directories.

##### Architectural Patterns
- Monorepo Multi-Module
– Enables independent lesson development & testing.
- Shared Library Pattern
– Common logic & assets centralized in utils.
- Convention-Over-Configuration
– Each lesson module follows the same directory layout (metadata, src, test).

## Diagram (Mermaid)

```mermaid
flowchart TB
    RootBuild["Root Gradle Build"]:::orchestrator
    JVM["JVM/Kotlin Stdlib"]:::external

    subgraph "Modules"
        subgraph "utils"
            UtilKt["Util.kt"]:::utilfile
            VariableKt["Variable.kt"]:::utilfile
            Images["images/"]:::resources
        end
        AlmostDone["AlmostDone"]:::lesson
        Chat["Chat"]:::lesson
        FeedbackSurvey["FeedbackSurvey"]:::lesson
        Hangman["Hangman"]:::lesson
        Introduction["Introduction"]:::lesson
        LastPush["LastPush"]:::lesson
        MastermindAdvanced["MastermindAdvanced"]:::lesson
        TheFirstDateWithProgramming["TheFirstDateWithProgramming"]:::lesson
        WarmUp["WarmUp"]:::lesson
    end

    RootBuild -->|"gradle tasks (compile, test, package)"| UtilKt
    RootBuild -->|"gradle tasks (compile, test, package)"| AlmostDone
    RootBuild -->|"gradle tasks (compile, test, package)"| Chat
    RootBuild -->|"gradle tasks (compile, test, package)"| FeedbackSurvey
    RootBuild -->|"gradle tasks (compile, test, package)"| Hangman
    RootBuild -->|"gradle tasks (compile, test, package)"| Introduction
    RootBuild -->|"gradle tasks (compile, test, package)"| LastPush
    RootBuild -->|"gradle tasks (compile, test, package)"| MastermindAdvanced
    RootBuild -->|"gradle tasks (compile, test, package)"| TheFirstDateWithProgramming
    RootBuild -->|"gradle tasks (compile, test, package)"| WarmUp

    AlmostDone -->|"compile-time dependency"| UtilKt
    Chat -->|"compile-time dependency"| UtilKt
    FeedbackSurvey -->|"compile-time dependency"| UtilKt
    Hangman -->|"compile-time dependency"| UtilKt
    Introduction -->|"compile-time dependency"| UtilKt
    LastPush -->|"compile-time dependency"| UtilKt
    MastermindAdvanced -->|"compile-time dependency"| UtilKt
    TheFirstDateWithProgramming -->|"compile-time dependency"| UtilKt
    WarmUp -->|"compile-time dependency"| UtilKt

    JVM --> AlmostDone
    JVM --> Chat
    JVM --> FeedbackSurvey
    JVM --> Hangman
    JVM --> Introduction
    JVM --> LastPush
    JVM --> MastermindAdvanced
    JVM --> TheFirstDateWithProgramming
    JVM --> WarmUp

    click UtilKt "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/utils/src/main/kotlin/util/Util.kt"
    click VariableKt "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/utils/src/main/kotlin/util/Variable.kt"
    click Images "https://github.com/joperor/kotlin_onboarding_introduction/tree/main/utils/src/main/resources/images/"
    click AlmostDone "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/AlmostDone/lesson-info.yaml"
    click Chat "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/Chat/lesson-info.yaml"
    click FeedbackSurvey "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/FeedbackSurvey/lesson-info.yaml"
    click Hangman "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/Hangman/lesson-info.yaml"
    click Introduction "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/Introduction/lesson-info.yaml"
    click LastPush "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/LastPush/lesson-info.yaml"
    click MastermindAdvanced "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/MastermindAdvanced/lesson-info.yaml"
    click TheFirstDateWithProgramming "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/TheFirstDateWithProgramming/lesson-info.yaml"
    click WarmUp "https://github.com/joperor/kotlin_onboarding_introduction/blob/main/WarmUp/lesson-info.yaml"
    classDef orchestrator fill:#FFA500,stroke:#333,stroke-width:2px
    classDef utils fill:#90EE90,stroke:#333,stroke-width:2px
    classDef lesson fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef utilfile fill:#98FB98,stroke:#333,stroke-width:1px
    classDef resources fill:#FFE4B5,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
```
