# digitalservicebund/hack-jira-cfd architecture

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

- Interactive diagram: https://gitdiagram.com/digitalservicebund/hack-jira-cfd
- Repository: https://github.com/digitalservicebund/hack-jira-cfd

## Overview

##### Main Components

a. External Systems:
- Jira Cloud (with REST API endpoint)
- Authentication Service (Atlassian API)

b. Core Application Components:
- Configuration Layer (Environment Variables)
- Jira Integration Layer
- Data Processing Core
- Visualization Layer

##### Component Organization

**[External Services Layer]**

**[Integration Layer]**

**[Core Processing Layer]**

**[Visualization Layer]**

##### Detailed Component Breakdown

a. External Services Layer (Top):

b. Integration Layer:
- "Jira Service" component (based on jira-service-functions.ts)

c. Core Processing Layer:
- Create "Core Processor" component (from core-functions.ts)
- Data transformation logic
- Cycle time calculation module
- CFD data processor

d. Visualization Layer:
- "Plotting Engine" component (from plotting-functions.ts)
- Three output types:
- Cycle Time Histogram
- Completion Percentage Graph

##### Data Flow Indicators

- Authentication flow from env vars to Atlassian
- Data retrieval from Jira API
- Data processing flow through core components
- Output flow to visualization

##### Important Details

a. Configuration Elements:
- ATLASSIAN_USER_EMAIL
- ATLASSIAN_API_TOKEN
- JIRA_API_BASE_URL
- JQL Queries
- State Configurations

b. Processing Features:
- Weekend removal process
- State tracking logic
- Cycle time calculation points

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Services Layer
    subgraph External
        JiraCloud[("Jira Cloud API")]:::external
        Auth[("Atlassian Auth")]:::external
    end

    %% Configuration Layer
    subgraph Config
        EnvVars["Environment Variables"]:::config
        JQL["JQL Queries"]:::config
        StateConfig["State Configurations"]:::config
    end

    %% Integration Layer
    subgraph Integration
        JiraClient["Jira Client"]:::integration
        JiraService["Jira Service"]:::integration
        JiraInterfaces["Jira Interfaces"]:::integration
    end

    %% Core Processing Layer
    subgraph Processing
        CoreProcessor["Core Processor"]:::processing
        DataModels["Data Models"]:::processing
        WeekendRemoval["Weekend Removal"]:::processing
        CycleTime["Cycle Time Calculator"]:::processing
        CFDProcessor["CFD Processor"]:::processing
    end

    %% Visualization Layer
    subgraph Visualization
        PlottingEngine["Plotting Engine"]:::visualization
        CycleTimeHist["Cycle Time Histogram"]:::output
        CompletionGraph["Completion % Graph"]:::output
        CFDGraph["Cumulative Flow Diagram"]:::output
    end

    %% Relationships
    EnvVars --> Auth
    JQL --> JiraClient
    StateConfig --> CoreProcessor
    
    Auth --> JiraClient
    JiraCloud --> JiraClient
    JiraClient --> JiraService
    JiraInterfaces --> JiraService
    
    JiraService --> CoreProcessor
    CoreProcessor --> DataModels
    CoreProcessor --> WeekendRemoval
    CoreProcessor --> CycleTime
    CoreProcessor --> CFDProcessor
    
    CycleTime --> PlottingEngine
    CFDProcessor --> PlottingEngine
    
    PlottingEngine --> CycleTimeHist
    PlottingEngine --> CompletionGraph
    PlottingEngine --> CFDGraph

    %% Click Events
    click JiraClient "https://github.com/digitalservicebund/hack-jira-cfd/blob/main/src/jira-related/jira-client-functions.ts"
    click JiraService "https://github.com/digitalservicebund/hack-jira-cfd/blob/main/src/jira-related/jira-service-functions.ts"
    click JiraInterfaces "https://github.com/digitalservicebund/hack-jira-cfd/blob/main/src/jira-related/jira-interfaces.ts"
    click CoreProcessor "https://github.com/digitalservicebund/hack-jira-cfd/blob/main/src/core/core-functions.ts"
    click DataModels "https://github.com/digitalservicebund/hack-jira-cfd/blob/main/src/core/core-interfaces.ts"
    click PlottingEngine "https://github.com/digitalservicebund/hack-jira-cfd/blob/main/src/plotting/plotting-functions.ts"

    %% Styles
    classDef external fill:#2374ab
    classDef config fill:#7d8491
    classDef integration fill:#39a0ed
    classDef processing fill:#ff8c42
    classDef visualization fill:#9381ff
    classDef output fill:#b8b8ff

    %% Legend
    subgraph Legend
        L1[("External Services")]:::external
        L2["Configuration"]:::config
        L3["Integration"]:::integration
        L4["Processing"]:::processing
        L5["Visualization"]:::visualization
        L6["Output"]:::output
    end
```
