# gaurang8576/open-source-scada-frontend architecture

> Architecture diagram of the GitHub repository gaurang8576/open-source-scada-frontend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gaurang8576/open-source-scada-frontend
- Repository: https://github.com/gaurang8576/open-source-scada-frontend

## Overview

This is a browser-based SCADA dashboard frontend. Users register or log in, enter a protected workspace, build a low-code or water-treatment diagram on a canvas, and save or deploy dashboards through backend requests. The workspace coordinates its navigation, palettes, and canvas; the canvas renders diagram elements and handles persistence and live simulation. Source excerpts show the main routing, authentication, workspace, and canvas behaviors, but do not expose every dashboard feature or backend contract, so uncertain links are omitted.

Main entry points: [`open-source-scada-frontend/src/Dashboard.jsx`](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/Dashboard.jsx) (Dashboard Workspace), [`open-source-scada-frontend/src/components/Canvas.jsx`](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/Canvas.jsx) (Diagram Canvas), [`open-source-scada-frontend/src/App.jsx`](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/App.jsx) (Application Router), [`open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentData.jsx`](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentData.jsx) (Water Component Catalog)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["Access &amp; Routing"]
  node_app["Application Router<br/>[App.jsx]"]
  node_login["Login<br/>[login.jsx]"]
  node_register["Registration<br/>[register.jsx]"]
  node_authnav["Auth Sidebar<br/>[Sidebar.jsx]"]
  node_api["API Client<br/>[api.js]"]
end

subgraph group_workspace["Dashboard Workspace"]
  node_dashboard["Dashboard Workspace<br/>[Dashboard.jsx]"]
  node_menubar["Menu Bar<br/>[MenuBar.jsx]"]
  node_navigation["Workspace Navigation<br/>[LeftNavBar.jsx]"]
  node_sidepanel["Side Panel<br/>[SidePanel.jsx]"]
end

subgraph group_diagram["Diagram Editor"]
  node_lowcode["Low-Code Palette<br/>[LowCodePanel.jsx]"]
  node_canvas["Diagram Canvas<br/>[Canvas.jsx]"]
end

subgraph group_water["Water Treatment"]
  node_waterpanel["Water Palette"]
  node_waterdata["Water Component Catalog"]
  node_waternode["Water Node Renderer<br/>[WaterNode.jsx]"]
  node_pipeedge["Pipe Edge Renderer<br/>[PipeEdge.jsx]"]
  node_parameters["Parameter Popup<br/>[ParameterPopup.jsx]"]
end

node_operator(("Operator"))
node_backend{{"SCADA Backend"}}

node_operator -->|"opens app"| node_app
node_app -->|"routes to"| node_login
node_app -->|"routes to"| node_register
node_app -->|"protects route"| node_dashboard
node_login -->|"submits credentials"| node_api
node_register -->|"creates account"| node_api
node_login -->|"renders"| node_authnav
node_register -->|"renders"| node_authnav
node_api -->|"sends requests"| node_backend
node_dashboard -->|"renders"| node_menubar
node_dashboard -->|"renders"| node_navigation
node_dashboard -->|"renders"| node_sidepanel
node_dashboard -->|"renders"| node_lowcode
node_dashboard -->|"renders"| node_waterpanel
node_dashboard -->|"controls canvas"| node_canvas
node_dashboard -->|"loads dashboard list"| node_backend
node_canvas -->|"saves or deploys"| node_backend
node_canvas -->|"renders nodes"| node_waternode
node_canvas -->|"renders connections"| node_pipeedge
node_canvas -->|"opens parameters"| node_parameters
node_waterpanel -->|"uses catalog"| node_waterdata
node_waternode -->|"uses definitions"| node_waterdata
node_pipeedge -->|"uses connection types"| node_waterdata
node_parameters -->|"uses definitions"| node_waterdata

click node_app "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/App.jsx"
click node_login "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/auth/login.jsx"
click node_register "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/auth/register.jsx"
click node_authnav "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/layout/Sidebar/Sidebar.jsx"
click node_api "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/services/api.js"
click node_dashboard "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/Dashboard.jsx"
click node_menubar "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/MenuBar.jsx"
click node_navigation "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/LeftNavBar.jsx"
click node_sidepanel "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/SidePanel.jsx"
click node_lowcode "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/LowCodePanel.jsx"
click node_canvas "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/Canvas.jsx"
click node_waterpanel "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentPanel.jsx"
click node_waterdata "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentData.jsx"
click node_waternode "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/WaterNode.jsx"
click node_pipeedge "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/PipeEdge.jsx"
click node_parameters "https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/ParameterPopup.jsx"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_login,node_register,node_authnav,node_api toneBlue
class node_dashboard,node_menubar,node_navigation,node_sidepanel toneAmber
class node_lowcode,node_canvas toneMint
class node_waterpanel,node_waterdata,node_waternode,node_pipeedge,node_parameters toneRose
class node_operator,node_backend toneIndigo
```

## Components

### Access & Routing

- [Application Router](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/App.jsx): `open-source-scada-frontend/src/App.jsx`
- [Login](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/auth/login.jsx): `open-source-scada-frontend/src/auth/login.jsx`
- [Registration](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/auth/register.jsx): `open-source-scada-frontend/src/auth/register.jsx`
- [Auth Sidebar](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/layout/Sidebar/Sidebar.jsx): `open-source-scada-frontend/src/components/layout/Sidebar/Sidebar.jsx`
- [API Client](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/services/api.js): `open-source-scada-frontend/src/services/api.js`

### Dashboard Workspace

- [Dashboard Workspace](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/Dashboard.jsx): `open-source-scada-frontend/src/Dashboard.jsx`
- [Menu Bar](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/MenuBar.jsx): `open-source-scada-frontend/src/components/MenuBar.jsx`
- [Workspace Navigation](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/LeftNavBar.jsx): `open-source-scada-frontend/src/components/LeftNavBar.jsx`
- [Side Panel](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/SidePanel.jsx): `open-source-scada-frontend/src/components/SidePanel.jsx`

### Diagram Editor

- [Low-Code Palette](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/LowCodePanel.jsx): `open-source-scada-frontend/src/components/LowCodePanel.jsx`
- [Diagram Canvas](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/Canvas.jsx): `open-source-scada-frontend/src/components/Canvas.jsx`

### Water Treatment

- [Water Palette](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentPanel.jsx): `open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentPanel.jsx`
- [Water Component Catalog](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentData.jsx): `open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentData.jsx`
- [Water Node Renderer](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/WaterNode.jsx): `open-source-scada-frontend/src/components/waterTreatment/WaterNode.jsx`
- [Pipe Edge Renderer](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/PipeEdge.jsx): `open-source-scada-frontend/src/components/waterTreatment/PipeEdge.jsx`
- [Parameter Popup](https://github.com/gaurang8576/open-source-scada-frontend/blob/main/open-source-scada-frontend/src/components/waterTreatment/ParameterPopup.jsx): `open-source-scada-frontend/src/components/waterTreatment/ParameterPopup.jsx`

### Other components

- **Operator**
- **SCADA Backend**

## Connections

- Operator → Application Router: opens app
- Application Router → Login: routes to (evidence: `open-source-scada-frontend/src/App.jsx`)
- Application Router → Registration: routes to (evidence: `open-source-scada-frontend/src/App.jsx`)
- Application Router → Dashboard Workspace: protects route (evidence: `open-source-scada-frontend/src/App.jsx`)
- Login → API Client: submits credentials (evidence: `open-source-scada-frontend/src/auth/login.jsx`)
- Registration → API Client: creates account (evidence: `open-source-scada-frontend/src/auth/register.jsx`)
- Login → Auth Sidebar: renders (evidence: `open-source-scada-frontend/src/auth/login.jsx`)
- Registration → Auth Sidebar: renders (evidence: `open-source-scada-frontend/src/auth/register.jsx`)
- API Client → SCADA Backend: sends requests (evidence: `open-source-scada-frontend/src/services/api.js`)
- Dashboard Workspace → Menu Bar: renders (evidence: `open-source-scada-frontend/src/Dashboard.jsx`)
- Dashboard Workspace → Workspace Navigation: renders (evidence: `open-source-scada-frontend/src/Dashboard.jsx`)
- Dashboard Workspace → Side Panel: renders (evidence: `open-source-scada-frontend/src/Dashboard.jsx`)
- Dashboard Workspace → Low-Code Palette: renders (evidence: `open-source-scada-frontend/src/Dashboard.jsx`)
- Dashboard Workspace → Water Palette: renders (evidence: `open-source-scada-frontend/src/Dashboard.jsx`)
- Dashboard Workspace → Diagram Canvas: controls canvas (evidence: `open-source-scada-frontend/src/Dashboard.jsx`)
- Dashboard Workspace → SCADA Backend: loads dashboard list (evidence: `open-source-scada-frontend/src/Dashboard.jsx`)
- Diagram Canvas → SCADA Backend: saves or deploys (evidence: `open-source-scada-frontend/src/components/Canvas.jsx`)
- Diagram Canvas → Water Node Renderer: renders nodes (evidence: `open-source-scada-frontend/src/components/Canvas.jsx`)
- Diagram Canvas → Pipe Edge Renderer: renders connections (evidence: `open-source-scada-frontend/src/components/Canvas.jsx`)
- Diagram Canvas → Parameter Popup: opens parameters (evidence: `open-source-scada-frontend/src/components/Canvas.jsx`)
- Water Palette → Water Component Catalog: uses catalog (evidence: `open-source-scada-frontend/src/components/waterTreatment/WaterTreatmentPanel.jsx`)
- Water Node Renderer → Water Component Catalog: uses definitions (evidence: `open-source-scada-frontend/src/components/waterTreatment/WaterNode.jsx`)
- Pipe Edge Renderer → Water Component Catalog: uses connection types (evidence: `open-source-scada-frontend/src/components/waterTreatment/PipeEdge.jsx`)
- Parameter Popup → Water Component Catalog: uses definitions (evidence: `open-source-scada-frontend/src/components/waterTreatment/ParameterPopup.jsx`)
