# mdawar/nats-dashboard architecture

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

- Interactive diagram: https://gitdiagram.com/mdawar/nats-dashboard
- Repository: https://github.com/mdawar/nats-dashboard

## Overview

##### Main Components

a. Client-Side Application Layer:
- Frontend SPA (Built with Astro + Solid.js)
- PWA capabilities (Service Worker)
- Local Storage for settings
- TanStack Query for state management

b. Data Layer:
- Direct communication with NATS servers
- JSONP fallback mechanism
- No backend storage

c. External Systems:
- NATS Server(s) with monitoring endpoints
- Optional reverse proxy for internal NATS servers

##### Key Architectural Elements

**[Browser Client]**

- [PWA Container]
- Service Worker (Offline Support)
- Local Storage (App Settings)

- [Frontend Application]
- Astro Static Site Generator
- Solid.js Components
- TanStack Query State Management

- [Data Fetching Layer]
- Primary: Fetch API (CORS)
- Fallback: JSONP Requests

- [External Systems]
- NATS Server(s)
- Monitoring Endpoints (:8222)
- Optional Reverse Proxy

##### Important Relationships to Highlight

- Direct connection between the frontend and NATS servers
- PWA wrapper around the application
- Demonstrate the two possible data fetching methods
- How the reverse proxy can sit between the app and internal NATS servers

##### Technical Details

- Port numbers (8222 for NATS monitoring)
- Data formats (JSON)
- Key technologies (Astro, Solid.js, TanStack Query)
- Browser storage mechanisms

##### Implementation Notes

- Use clear, professional fonts
- Notes about CORS requirements
- Document the JSONP fallback mechanism
- Version compatibility notes (NATS server versions)

Remember to include a note about the mixed content limitations when accessing HTTP NATS servers from HTTPS deployments, as this is a crucial architectural consideration.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Browser["Browser Environment"]
        PWA["PWA Container"]
        click PWA "https://github.com/mdawar/nats-dashboard/blob/main/src/sw.ts"
        
        subgraph FrontEnd["Frontend Application"]
            App["Application Core"]:::core
            click App "https://github.com/mdawar/nats-dashboard/blob/main/src/components/dashboard/App.tsx"
            
            StateManagement["State Management"]:::state
            click StateManagement "https://github.com/mdawar/nats-dashboard/blob/main/src/components/dashboard/QueryClientProvider.tsx"
            
            Settings["Settings Management"]:::settings
            click Settings "https://github.com/mdawar/nats-dashboard/blob/main/src/components/context/settings.tsx"
            
            subgraph DashboardComponents["Dashboard Components"]
                Overview["Overview Page"]:::component
                click Overview "https://github.com/mdawar/nats-dashboard/blob/main/src/components/dashboard/pages/Overview.tsx"
                
                Info["Info Page"]:::component
                click Info "https://github.com/mdawar/nats-dashboard/blob/main/src/components/dashboard/pages/Info.tsx"
                
                Connections["Connections Page"]:::component
                click Connections "https://github.com/mdawar/nats-dashboard/blob/main/src/components/dashboard/pages/Connections.tsx"
                
                JetStream["JetStream Page"]:::component
                click JetStream "https://github.com/mdawar/nats-dashboard/blob/main/src/components/dashboard/pages/JetStream.tsx"
                
                ServerMonitoring["Server Monitoring"]:::component
                click ServerMonitoring "https://github.com/mdawar/nats-dashboard/blob/main/src/components/dashboard/server/ServerInfo.tsx"
            end
        end
        
        subgraph DataLayer["Data Fetching Layer"]
            FetchAPI["Primary: Fetch API"]:::data
            JSONP["Fallback: JSONP"]:::data
            click JSONP "https://github.com/mdawar/nats-dashboard/blob/main/src/lib/jsonp.ts"
            
            NATSIntegration["NATS Integration"]:::data
            click NATSIntegration "https://github.com/mdawar/nats-dashboard/blob/main/src/lib/info.ts"
        end
        
        Storage["Local Storage"]:::storage
        ServiceWorker["Service Worker"]:::pwa
        click ServiceWorker "https://github.com/mdawar/nats-dashboard/blob/main/src/sw-register.ts"
    end
    
    subgraph External["External Systems"]
        NATS["NATS Server(s)"]:::external
        ReverseProxy["Reverse Proxy"]:::external
        MonitoringEndpoint["Monitoring Endpoint :8222"]:::endpoint
    end
    
    %% Connections
    App --> StateManagement
    App --> Settings
    StateManagement --> DataLayer
    Settings --> Storage
    PWA --> ServiceWorker
    PWA --> Storage
    
    DataLayer --> FetchAPI & JSONP
    FetchAPI & JSONP --> NATSIntegration
    NATSIntegration -.-> ReverseProxy
    ReverseProxy -.-> NATS
    NATSIntegration --> NATS
    NATS --> MonitoringEndpoint
    
    %% Styles
    classDef core fill:#2196F3,color:white
    classDef state fill:#9C27B0,color:white
    classDef settings fill:#FF9800,color:white
    classDef component fill:#4CAF50,color:white
    classDef data fill:#03A9F4,color:white
    classDef storage fill:#795548,color:white
    classDef pwa fill:#E91E63,color:white
    classDef external fill:#607D8B,color:white
    classDef endpoint fill:#FF5722,color:white
```
