# ahmad-alipoor/hub-minertools architecture

> Architecture diagram of the GitHub repository ahmad-alipoor/hub-minertools, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ahmad-alipoor/hub-minertools
- Repository: https://github.com/ahmad-alipoor/hub-minertools

## Overview

Hub-MinerTools is a MinerTools monitoring and operations hub: users sign in, work in customer or admin workspaces, and manage farms, connections, miners, reports, and commercial services. The browser app uses a shared API client; the Go backend provides the API, control-plane services, workers, and product integrations. The README documents the frontend/backend split and identity provider. Source excerpts show frontend routing and API use, but do not expose most backend wiring, so those relationships are left unconnected rather than inferred.

Main entry points: [`frontend/src/App.tsx`](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/App.tsx) (Web application), [`frontend/src/lib/api.ts`](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/lib/api.ts) (API client), [`frontend/src/pages/AuthPage.tsx`](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/AuthPage.tsx) (Authentication), [`frontend/src/pages/FarmsPage.tsx`](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/FarmsPage.tsx) (Customer workspace)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["Browser experience"]
  node_webapp["Web application<br/>[App.tsx]"]
  node_auth["Authentication<br/>[AuthPage.tsx]"]
  node_customer["Customer workspace<br/>[FarmsPage.tsx]"]
  node_farmdetails["Farm details"]
  node_connections["Connections"]
  node_admin["Admin operations"]
  node_clientconfig["Client configuration"]
end

subgraph group_api["API and control plane"]
  node_apiclient["API client<br/>[api.ts]"]
  node_dashboardapi["Dashboard API<br/>[server.go]"]
  node_controlplane[("Control-plane data")]
  node_commands["Command workers"]
end

subgraph group_monitoring["Monitoring operations"]
  node_collector["Telemetry collection<br/>[collector.go]"]
  node_minerdrivers["Miner integrations"]
  node_productadapters["Product monitoring"]
  node_provisioning["Router provisioning"]
  node_alerts["Alert engine<br/>[engine.go]"]
end

subgraph group_commerce["Commercial services"]
  node_commercial["Billing and quota"]
  node_payments["Payment providers<br/>[provider.go]"]
end

node_user(("User"))
node_identity["Casdoor identity"]

node_user -->|"uses"| node_webapp
node_webapp -->|"routes to"| node_auth
node_webapp -->|"routes to"| node_customer
node_webapp -->|"routes to"| node_farmdetails
node_webapp -->|"routes to"| node_connections
node_webapp -->|"routes to"| node_admin
node_webapp -->|"routes to"| node_clientconfig
node_webapp -->|"uses"| node_apiclient
node_auth -->|"requests"| node_apiclient
node_customer -->|"requests"| node_apiclient
node_farmdetails -->|"requests"| node_apiclient
node_connections -->|"requests"| node_apiclient
node_admin -->|"requests"| node_apiclient
node_clientconfig -->|"requests"| node_apiclient
node_apiclient -->|"calls"| node_dashboardapi
node_user -->|"authenticates with"| node_identity

click node_webapp "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/App.tsx"
click node_auth "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/AuthPage.tsx"
click node_customer "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/FarmsPage.tsx"
click node_farmdetails "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/FarmDetailsPage.tsx"
click node_connections "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/ConnectionsPage.tsx"
click node_admin "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/AdminBusinessPage.tsx"
click node_clientconfig "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/AdminPublicClientConfigPage.tsx"
click node_apiclient "https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/lib/api.ts"
click node_dashboardapi "https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/dashboard/server.go"
click node_controlplane "https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/controlplane"
click node_collector "https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/collector/collector.go"
click node_minerdrivers "https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/miner"
click node_productadapters "https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/productadapter"
click node_provisioning "https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/provisioning/routeros_package.go"
click node_alerts "https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/alerts/engine.go"
click node_commercial "https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/billing"
click node_payments "https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/paymentprovider/provider.go"
click node_commands "https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/commands"

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_webapp,node_auth,node_customer,node_farmdetails,node_connections,node_admin,node_clientconfig,node_user toneBlue
class node_apiclient,node_dashboardapi,node_controlplane,node_commands toneAmber
class node_collector,node_minerdrivers,node_productadapters,node_provisioning,node_alerts toneMint
class node_commercial,node_payments toneRose
class node_identity toneIndigo
```

## Components

### Browser experience

- [Web application](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Authentication](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/AuthPage.tsx): `frontend/src/pages/AuthPage.tsx`
- [Customer workspace](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/FarmsPage.tsx): `frontend/src/pages/FarmsPage.tsx`
- [Farm details](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/FarmDetailsPage.tsx): `frontend/src/pages/FarmDetailsPage.tsx`
- [Connections](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/ConnectionsPage.tsx): `frontend/src/pages/ConnectionsPage.tsx`
- [Admin operations](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/AdminBusinessPage.tsx): `frontend/src/pages/AdminBusinessPage.tsx`
- [Client configuration](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/pages/AdminPublicClientConfigPage.tsx): `frontend/src/pages/AdminPublicClientConfigPage.tsx`

### API and control plane

- [API client](https://github.com/ahmad-alipoor/hub-minertools/blob/main/frontend/src/lib/api.ts): `frontend/src/lib/api.ts`
- [Dashboard API](https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/dashboard/server.go): `backend/internal/dashboard/server.go`
- [Control-plane data](https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/controlplane): `backend/internal/controlplane`
- [Command workers](https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/commands): `backend/internal/commands`

### Monitoring operations

- [Telemetry collection](https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/collector/collector.go): `backend/internal/collector/collector.go`
- [Miner integrations](https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/miner): `backend/internal/miner`
- [Product monitoring](https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/productadapter): `backend/internal/productadapter`
- [Router provisioning](https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/provisioning/routeros_package.go): `backend/internal/provisioning/routeros_package.go`
- [Alert engine](https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/alerts/engine.go): `backend/internal/alerts/engine.go`

### Commercial services

- [Billing and quota](https://github.com/ahmad-alipoor/hub-minertools/tree/main/backend/internal/billing): `backend/internal/billing`
- [Payment providers](https://github.com/ahmad-alipoor/hub-minertools/blob/main/backend/internal/paymentprovider/provider.go): `backend/internal/paymentprovider/provider.go`

### Other components

- **User**
- **Casdoor identity**

## Connections

- User → Web application: uses
- Web application → Authentication: routes to (evidence: `frontend/src/App.tsx`)
- Web application → Customer workspace: routes to (evidence: `frontend/src/App.tsx`)
- Web application → Farm details: routes to (evidence: `frontend/src/App.tsx`)
- Web application → Connections: routes to (evidence: `frontend/src/App.tsx`)
- Web application → Admin operations: routes to (evidence: `frontend/src/App.tsx`)
- Web application → Client configuration: routes to (evidence: `frontend/src/App.tsx`)
- Web application → API client: uses (evidence: `frontend/src/App.tsx`)
- Authentication → API client: requests (evidence: `frontend/src/pages/AuthPage.tsx`)
- Customer workspace → API client: requests
- Farm details → API client: requests
- Connections → API client: requests
- Admin operations → API client: requests (evidence: `frontend/src/pages/AdminBusinessPage.tsx`)
- Client configuration → API client: requests (evidence: `frontend/src/pages/AdminPublicClientConfigPage.tsx`)
- API client → Dashboard API: calls
- User → Casdoor identity: authenticates with
