# eidu/integration-library architecture

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

- Interactive diagram: https://gitdiagram.com/eidu/integration-library
- Repository: https://github.com/eidu/integration-library

## Overview

##### Main Components

a. Core Library Components:
- Three main class components within:
- RunLearningUnitRequest
- RunLearningUnitResult
- ResultItem

b. Integration Points:
- An "EIDU Platform" cloud/external system
- A "Host Android App" component

c. Build System Layer:
- A Gradle build system component
- Maven Central publishing pathway

##### Relationship Flows

- Host App → Integration Library (implementation dependency)
- Integration Library ↔ EIDU Platform (data exchange)
- Build System → Maven Central (deployment)

##### Component Details

- Rectangle with rounded corners for the main library module (blue)
- Rectangles for internal classes (light blue)
- Hexagon for Host Android App (green)

##### Technical Specifications

Annotations showing:
- Java as the implementation language
- Android platform compatibility
- MIT License indicator
- Maven Central distribution channel

##### Testing Layer

A testing component that includes:
- Unit Tests (RunLearningUnitRequestTest, RunLearningUnitResultTest)
- Android Instrumentation Tests (ResultItemTest)

##### Build/CI Pipeline

A small section showing:
- GitHub Actions workflows
- Gradle build process
- Publication process

Specific Considerations:

##### Important Elements to Highlight
- The library's role as a bridge between host apps and EIDU platform
- The simplicity of the integration process
- The testing coverage

##### Notes Section
A notes section mentioning:
- Version compatibility
- License information
- Support contact information

Remember to use standard UML notation where appropriate but prioritize clarity and understanding over strict UML compliance, as this is an architectural overview rather than a detailed technical specification.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Integration Environment"
        HostApp[Host Android App]:::hostapp
        EIDU[EIDU Platform]:::platform
    end

    subgraph "EIDU Integration Library"
        direction TB
        Request["RunLearningUnitRequest"]:::core
        Result["RunLearningUnitResult"]:::core
        ResultI["ResultItem"]:::core
    end

    subgraph "Testing Framework"
        direction TB
        UnitTests["Unit Tests"]:::test
        InstrTests["Android Instrumentation Tests"]:::test
    end

    subgraph "Build & CI Pipeline"
        direction TB
        GActions["GitHub Actions"]:::ci
        Gradle["Gradle Build System"]:::build
        Maven["Maven Central"]:::repo
    end

    %% Relationships
    HostApp <--> Request
    Request <--> EIDU
    EIDU <--> Result
    Result --> ResultI
    
    UnitTests --> Request
    UnitTests --> Result
    InstrTests --> ResultI
    
    GActions --> Gradle
    Gradle --> Maven

    %% Click Events
    click Request "https://github.com/EIDU/integration-library/blob/main/integration-library/src/main/java/com/eidu/integration/RunLearningUnitRequest.java"
    click Result "https://github.com/EIDU/integration-library/blob/main/integration-library/src/main/java/com/eidu/integration/RunLearningUnitResult.java"
    click ResultI "https://github.com/EIDU/integration-library/blob/main/integration-library/src/main/java/com/eidu/integration/ResultItem.java"
    click UnitTests "https://github.com/EIDU/integration-library/tree/main/integration-library/src/test/java/com/eidu/integration"
    click InstrTests "https://github.com/EIDU/integration-library/tree/main/integration-library/src/androidTest/java/com/eidu/integration"
    click GActions "https://github.com/EIDU/integration-library/tree/main/.github/workflows"
    click Gradle "https://github.com/EIDU/integration-library/blob/main/build.gradle.kts"
    click Maven "https://github.com/EIDU/integration-library/blob/main/integration-library/build.gradle.kts"

    %% Styling
    classDef core fill:#a2d2ff,stroke:#333,stroke-width:2px
    classDef hostapp fill:#90be6d,stroke:#333,stroke-width:2px
    classDef platform fill:#f0f0f0,stroke:#333,stroke-width:2px
    classDef test fill:#f9c74f,stroke:#333,stroke-width:2px
    classDef ci fill:#f94144,stroke:#333,stroke-width:2px
    classDef build fill:#577590,stroke:#333,stroke-width:2px
    classDef repo fill:#9b5de5,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1[Core Components]:::core
        L2[Host Application]:::hostapp
        L3[Platform]:::platform
        L4[Testing]:::test
        L5[CI/CD]:::ci
        L6[Build Tools]:::build
        L7[Repository]:::repo
    end
```
