# stanko/pulsar architecture

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

- Interactive diagram: https://gitdiagram.com/stanko/pulsar
- Repository: https://github.com/stanko/pulsar

## Overview

##### Main Components Identification

The system can be broken down into these primary components:

a) Rendering Engines
- Canvas Grid Renderer
- SVG Grid Renderer
- GIF Generator

b) Core Library
- State Management
- Calculation Engine
- Editor Interface
- Examples/Tutorial System

##### Component Relationships

- User Input → Editor → State Management → Renderers
- State Management → Calculation Engine → Renderers
- Renderers → GIF Generator
- Examples System → State Management

##### Specific Implementation Details

a) Rendering Pipeline:
**User Input → State → Calculations → Renderer (Canvas/SVG) → Display**
- ↘ GIF Generator

b) Grid System Variants:
- Circles
- Hexagons
- Triangles

c) Worker Architecture:
- Separation between main thread and worker thread
- GIF generation process flow

##### Technical Stack Indicators

Technology badges or labels for:
- TypeScript
- Canvas API
- SVG
- Web Workers
- Vite (build system)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        Editor["Editor Interface"]:::ui
        Tutorial["Tutorial System"]:::ui
        Share["Share Button"]:::ui
        Examples["Examples System"]:::ui
    end

    subgraph "Application Logic Layer"
        App["Main Application"]:::core
        State["State Management"]:::core
        Calc["Calculation Engine"]:::core
        Colors["Color Management"]:::core
        Worker["Worker Architecture"]:::worker
        URL["URL Management"]:::util
        Debug["Debug Utilities"]:::util
    end

    subgraph "Rendering Layer"
        direction TB
        subgraph "Canvas Grid"
            CanvasRenderer["Canvas Renderer"]:::render
            CCircles["Circles Grid"]:::grid
            CHex["Hexagon Grid"]:::grid
            CTriangles["Triangle Grid"]:::grid
        end

        subgraph "SVG Grid"
            SVGRenderer["SVG Renderer"]:::render
            SCircles["Circles Grid"]:::grid
            SHex["Hexagon Grid"]:::grid
            STriangles["Triangle Grid"]:::grid
        end
    end

    subgraph "Export Layer"
        GIFGen["GIF Generator"]:::export
        GIFWorker["GIF Worker"]:::worker
    end

    %% Relationships
    Editor --> State
    Tutorial --> State
    Share --> State
    Examples --> State
    
    State --> Calc
    Calc --> Colors
    
    State --> CanvasRenderer
    State --> SVGRenderer
    
    CanvasRenderer --> CCircles & CHex & CTriangles
    SVGRenderer --> SCircles & SHex & STriangles
    
    CanvasRenderer & SVGRenderer --> GIFGen
    GIFGen --> GIFWorker
    
    App --> State
    Worker --> State

    %% Click Events
    click App "https://github.com/Stanko/pulsar/blob/dev/src/ts/app.ts"
    click Editor "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/editor.ts"
    click Tutorial "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/tutorial.ts"
    click Share "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/share-button.ts"
    click Examples "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/examples.ts"
    click State "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/state.ts"
    click Calc "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/calculate.ts"
    click Colors "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/colors.ts"
    click Worker "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/worker.ts"
    click URL "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/url.ts"
    click Debug "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/debug.ts"
    click CanvasRenderer "https://github.com/Stanko/pulsar/tree/dev/src/ts/canvas-grid/"
    click SVGRenderer "https://github.com/Stanko/pulsar/tree/dev/src/ts/svg-grid/"
    click CCircles "https://github.com/Stanko/pulsar/blob/dev/src/ts/canvas-grid/circles.ts"
    click CHex "https://github.com/Stanko/pulsar/blob/dev/src/ts/canvas-grid/hex.ts"
    click CTriangles "https://github.com/Stanko/pulsar/blob/dev/src/ts/canvas-grid/triangles.ts"
    click SCircles "https://github.com/Stanko/pulsar/blob/dev/src/ts/svg-grid/circles.ts"
    click SHex "https://github.com/Stanko/pulsar/blob/dev/src/ts/svg-grid/hex.ts"
    click STriangles "https://github.com/Stanko/pulsar/blob/dev/src/ts/svg-grid/triangles.ts"
    click GIFGen "https://github.com/Stanko/pulsar/blob/dev/src/ts/lib/gif.ts"
    click GIFWorker "https://github.com/Stanko/pulsar/blob/dev/src/public/gif.worker.js"

    %% Styling
    classDef core fill:#2b6cb0,stroke:#1a4971,color:#fff
    classDef ui fill:#ed8936,stroke:#c05621,color:#fff
    classDef render fill:#38a169,stroke:#2f855a,color:#fff
    classDef grid fill:#4fd1c5,stroke:#319795,color:#fff
    classDef worker fill:#805ad5,stroke:#553c9a,color:#fff
    classDef util fill:#718096,stroke:#4a5568,color:#fff
    classDef export fill:#d53f8c,stroke:#b83280,color:#fff
```
