# jstrieb/poker-chipper architecture

> Architecture diagram of the GitHub repository jstrieb/poker-chipper, 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/jstrieb/poker-chipper
- Repository: https://github.com/jstrieb/poker-chipper

## Overview

##### Main Components

a. Client-Side Components:
- Frontend UI (Svelte Application)
- Web Worker Thread
- Service Worker
- WebAssembly Module (SCIP Solver)

b. External Components:
- Static Web Server (GitHub Pages)

##### User Interface Layer
- App.svelte (main container)
- Child components (Button, Checkbox, Details, NumericInput, etc.)
- Use rounded rectangles for UI components

##### Processing Layer
a. Main Thread:
- Svelte runtime
- Helpers.js for utility functions
b. Web Worker Thread:
- Solve.js and solveWorker.js
- SCIP WASM module integration
- Use rectangles for processing units

##### Cache/Storage Layer
- Service Worker
- Browser Cache

Key Relationships to Highlight:

##### Data Flow
- User Input → Main Thread → Web Worker
- Web Worker → SCIP Solver → Optimization Results
- Results → Main Thread → UI Updates

##### Asset Management
- Service Worker ↔ Static Assets
- Service Worker ↔ Browser Cache

##### WASM Integration
- How the compiled SCIP solver (scip.wasm) integrates with the Web Worker
- Use a special connector to indicate WASM execution

Special Considerations:

##### Progressive Web App Features
- Manifest.json and serviceWorker.js connections
- Offline functionality flow

##### Optimization Pipeline
- Conversion of user inputs to MINLP model
- SCIP solver integration points

##### Static Asset Handling
- Caching strategy
- How assets are served from GitHub Pages

##### Use a clear hierarchy
- Top: User Interface
- Middle: Processing
- Bottom: Storage/Caching

##### Version/build information
- SCIP solver version
- WebAssembly module details

- The static nature of the application
- The separation of concerns between UI and processing
- The role of Web Workers in non-blocking optimization
- The integration of the WASM-compiled SCIP solver
- The PWA capabilities and offline functionality

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        App["App.svelte"]
        Button["Button.svelte"]
        Checkbox["Checkbox.svelte"]
        Details["Details.svelte"]
        NumInput["NumericInput.svelte"]
        GrowInput["GrowableInput.svelte"]
        
        App --> Button
        App --> Checkbox
        App --> Details
        App --> NumInput
        App --> GrowInput
    end

    subgraph "Processing Layer"
        subgraph "Main Thread"
            SvelteRuntime["Svelte Runtime"]
            Helpers["Utility Functions"]
        end
        
        subgraph "Web Worker Thread"
            SolveWorker["Solve Worker"]
            Solve["Solve Logic"]
            WASM["SCIP WASM Module"]
        end
    end

    subgraph "Cache/Storage Layer"
        SW["Service Worker"]
        Cache["Browser Cache"]
        Manifest["Web Manifest"]
        GlobalCSS["Global Styles"]
    end

    subgraph "Build & Deploy"
        Vite["Vite Config"]
        Deploy["GitHub Actions"]
    end

    %% Data Flow Relationships
    App --> SvelteRuntime
    SvelteRuntime --> Helpers
    SvelteRuntime --> SolveWorker
    SolveWorker --> Solve
    Solve --> WASM
    WASM --> Solve
    Solve --> SolveWorker
    SolveWorker --> SvelteRuntime

    %% Cache Relationships
    SW --> Cache
    SW -.-> Manifest
    SW -.-> GlobalCSS

    %% Build Relationships
    Vite --> Deploy

    %% Styling
    classDef ui fill:#a8d0e6,stroke:#333,stroke-width:2px
    classDef processing fill:#95e1d3,stroke:#333,stroke-width:2px
    classDef worker fill:#f8b195,stroke:#333,stroke-width:2px
    classDef storage fill:#d4a5a5,stroke:#333,stroke-width:2px
    classDef build fill:#a8e6cf,stroke:#333,stroke-width:2px

    class App,Button,Checkbox,Details,NumInput,GrowInput ui
    class SvelteRuntime,Helpers processing
    class SolveWorker,Solve,WASM worker
    class SW,Cache,Manifest,GlobalCSS storage
    class Vite,Deploy build

    %% Click Events
    click App "https://github.com/jstrieb/poker-chipper/blob/master/src/App.svelte"
    click Button "https://github.com/jstrieb/poker-chipper/blob/master/src/Button.svelte"
    click Checkbox "https://github.com/jstrieb/poker-chipper/blob/master/src/Checkbox.svelte"
    click Details "https://github.com/jstrieb/poker-chipper/blob/master/src/Details.svelte"
    click NumInput "https://github.com/jstrieb/poker-chipper/blob/master/src/NumericInput.svelte"
    click GrowInput "https://github.com/jstrieb/poker-chipper/blob/master/src/GrowableInput.svelte"
    click SolveWorker "https://github.com/jstrieb/poker-chipper/blob/master/src/solveWorker.js"
    click Solve "https://github.com/jstrieb/poker-chipper/blob/master/src/solve.js"
    click WASM "https://github.com/jstrieb/poker-chipper/blob/master/src/compiled/scip.wasm"
    click SW "https://github.com/jstrieb/poker-chipper/blob/master/public/serviceWorker.js"
    click Manifest "https://github.com/jstrieb/poker-chipper/blob/master/public/manifest.json"
    click GlobalCSS "https://github.com/jstrieb/poker-chipper/blob/master/public/global.css"
    click Helpers "https://github.com/jstrieb/poker-chipper/blob/master/src/helpers.js"
    click Vite "https://github.com/jstrieb/poker-chipper/blob/master/vite.config.js"
    click Deploy "https://github.com/jstrieb/poker-chipper/blob/master/.github/workflows/deploy.yml"
```
