# sireluke/relayworks architecture

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

- Interactive diagram: https://gitdiagram.com/sireluke/relayworks
- Repository: https://github.com/sireluke/relayworks

## Overview

RelayWorks coordinates agency work from client task creation through worker execution and reviewer approval, with operational dashboards and payment flows for clients, workers, operators, owners, and reviewers. The frontend provides role-specific dashboards and service clients; the Express backend exposes routes, controllers, and services, with PostgreSQL-backed task/review logic represented in sampled code. The README documents the broader coordination and payment capabilities, but several backend routes and services were not sampled, so their internal connections are not asserted.

Main entry points: [`frontend/src/App.tsx`](https://github.com/sireluke/relayworks/blob/main/frontend/src/App.tsx) (Dashboard routing), [`backend/src/routes/task.routes.ts`](https://github.com/sireluke/relayworks/blob/main/backend/src/routes/task.routes.ts) (Task routes), [`frontend/src/services/clientService.ts`](https://github.com/sireluke/relayworks/blob/main/frontend/src/services/clientService.ts) (Client service), [`frontend/src/services/workerService.ts`](https://github.com/sireluke/relayworks/blob/main/frontend/src/services/workerService.ts) (Worker service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Role Dashboards"]
  node_app_routes["Dashboard routing<br/>[App.tsx]"]
  node_client_dashboard["Client dashboard"]
  node_worker_dashboard["Worker dashboard"]
  node_reviewer_dashboard["Reviewer dashboard"]
  node_operator_dashboard["Operator dashboard"]
  node_owner_dashboard["Owner dashboard<br/>[OwnerDashboard.tsx]"]
  node_client_task_ui["Task creation<br/>[CreateTaskForm.tsx]"]
  node_worker_submit_ui["Work submission"]
  node_review_ui["Review decisions"]
end

subgraph group_workflow["Work Coordination"]
  node_client_api["Client service<br/>[clientService.ts]"]
  node_worker_api["Worker service<br/>[workerService.ts]"]
  node_review_api["Reviewer service<br/>[reviewerService.ts]"]
  node_operator_api["Operator service<br/>[operatorService.ts]"]
  node_task_routes["Task routes<br/>[task.routes.ts]"]
  node_task_controller["Task controller<br/>[taskController.ts]"]
  node_task_service["Task operations<br/>[taskService.ts]"]
  node_review_controller["Review controller"]
  node_review_service[("Review metrics<br/>[reviewerService.ts]")]
  node_dashboard_controller["Dashboard controller"]
  node_dashboard_service["Dashboard service"]
end

subgraph group_money["Payments and Account"]
  node_payment_ui["Payment views<br/>[InvoicePanel.tsx]"]
  node_worker_payout_ui["Worker payouts"]
  node_payment_routes["Payment routes<br/>[payment.routes.ts]"]
  node_payment_controller["Payment controller"]
  node_payment_service["Payment operations<br/>[payment.service.ts]"]
end

subgraph group_platform["Backend Platform"]
  node_auth_routes["Login and registration<br/>[authRoutes.ts]"]
  node_auth_service["Authentication service<br/>[AuthService.ts]"]
  node_user_model[("User record<br/>[User.ts]")]
  node_server["HTTP server<br/>[server.ts]"]
  node_app["Express app<br/>[app.ts]"]
  node_auth_middleware["Authentication middleware<br/>[auth.middleware.ts]"]
  node_role_middleware["Role middleware<br/>[role.middleware.ts]"]
  node_activity["Activity tracking"]
end

node_agency_users(("Agency users"))

node_agency_users -->|"choose role view"| node_app_routes
node_app_routes -->|"routes to"| node_client_dashboard
node_app_routes -->|"routes to"| node_worker_dashboard
node_app_routes -->|"routes to"| node_reviewer_dashboard
node_app_routes -->|"routes to"| node_operator_dashboard
node_app_routes -->|"routes to"| node_owner_dashboard
node_client_dashboard -->|"loads overview"| node_client_api
node_client_dashboard -->|"renders"| node_client_task_ui
node_client_task_ui -->|"creates task"| node_client_api
node_worker_dashboard -->|"loads overview"| node_worker_api
node_worker_dashboard -->|"renders"| node_worker_submit_ui
node_worker_submit_ui -->|"submits work"| node_worker_api
node_reviewer_dashboard -->|"loads overview"| node_review_api
node_reviewer_dashboard -->|"renders"| node_review_ui
node_review_ui -->|"sends decisions"| node_review_api
node_operator_dashboard -->|"loads task data"| node_operator_api
node_client_api -.->|"requests task endpoints"| node_task_routes
node_worker_api -.->|"requests task endpoints"| node_task_routes
node_review_api -.->|"requests review endpoints"| node_task_routes
node_server -->|"mounts routes"| node_task_routes
node_task_routes -->|"checks authentication"| node_auth_middleware
node_task_controller -->|"delegates task work"| node_task_service
node_review_controller -->|"loads dashboard"| node_review_service
node_review_service -.->|"counts review state"| node_agency_users
node_dashboard_controller -->|"loads dashboard data"| node_dashboard_service
node_payment_ui -->|"loads invoices"| node_client_api
node_worker_payout_ui -->|"loads payouts"| node_worker_api
node_payment_routes -->|"dispatches requests"| node_payment_controller
node_payment_controller -->|"creates and records"| node_payment_service
node_auth_routes -->|"checks credentials"| node_auth_service
node_auth_service -->|"uses user model"| node_user_model
node_app -->|"configures middleware"| node_auth_middleware
node_app -->|"configures middleware"| node_role_middleware
node_role_middleware -->|"uses identity"| node_auth_middleware

click node_app_routes "https://github.com/sireluke/relayworks/blob/main/frontend/src/App.tsx"
click node_client_dashboard "https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/client/clientdashboard.tsx"
click node_worker_dashboard "https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/worker/WorkerDashboard.tsx"
click node_reviewer_dashboard "https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/reviewer/ReviewerDashboard.tsx"
click node_operator_dashboard "https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/operator/operatorDashboard.tsx"
click node_owner_dashboard "https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/owner/OwnerDashboard.tsx"
click node_client_task_ui "https://github.com/sireluke/relayworks/blob/main/frontend/src/components/client/CreateTaskForm.tsx"
click node_worker_submit_ui "https://github.com/sireluke/relayworks/blob/main/frontend/src/components/worker/WorkerSubmitPanel.tsx"
click node_review_ui "https://github.com/sireluke/relayworks/blob/main/frontend/src/components/reviewer/ReviewerApprovalPanel.tsx"
click node_client_api "https://github.com/sireluke/relayworks/blob/main/frontend/src/services/clientService.ts"
click node_worker_api "https://github.com/sireluke/relayworks/blob/main/frontend/src/services/workerService.ts"
click node_review_api "https://github.com/sireluke/relayworks/blob/main/frontend/src/services/reviewerService.ts"
click node_operator_api "https://github.com/sireluke/relayworks/blob/main/frontend/src/services/operatorService.ts"
click node_task_routes "https://github.com/sireluke/relayworks/blob/main/backend/src/routes/task.routes.ts"
click node_task_controller "https://github.com/sireluke/relayworks/blob/main/backend/src/controllers/taskController.ts"
click node_task_service "https://github.com/sireluke/relayworks/blob/main/backend/src/services/taskService.ts"
click node_review_controller "https://github.com/sireluke/relayworks/blob/main/backend/src/controllers/reviewerController.ts"
click node_review_service "https://github.com/sireluke/relayworks/blob/main/backend/src/services/reviewerService.ts"
click node_dashboard_controller "https://github.com/sireluke/relayworks/blob/main/dashboard.controller.ts"
click node_dashboard_service "https://github.com/sireluke/relayworks/blob/main/dashboard.service.ts"
click node_payment_ui "https://github.com/sireluke/relayworks/blob/main/frontend/src/components/client/InvoicePanel.tsx"
click node_worker_payout_ui "https://github.com/sireluke/relayworks/blob/main/frontend/src/components/worker/WorkerPayoutPanel.tsx"
click node_payment_routes "https://github.com/sireluke/relayworks/blob/main/payment.routes.ts"
click node_payment_controller "https://github.com/sireluke/relayworks/blob/main/payment.controller.ts"
click node_payment_service "https://github.com/sireluke/relayworks/blob/main/payment.service.ts"
click node_auth_routes "https://github.com/sireluke/relayworks/blob/main/backend/src/routes/authRoutes.ts"
click node_auth_service "https://github.com/sireluke/relayworks/blob/main/backend/src/services/AuthService.ts"
click node_user_model "https://github.com/sireluke/relayworks/blob/main/backend/src/models/User.ts"
click node_server "https://github.com/sireluke/relayworks/blob/main/backend/src/server.ts"
click node_app "https://github.com/sireluke/relayworks/blob/main/backend/src/app.ts"
click node_auth_middleware "https://github.com/sireluke/relayworks/blob/main/backend/src/middleware/auth.middleware.ts"
click node_role_middleware "https://github.com/sireluke/relayworks/blob/main/backend/src/middleware/role.middleware.ts"
click node_activity "https://github.com/sireluke/relayworks/blob/main/activity.service.ts"

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_routes,node_client_dashboard,node_worker_dashboard,node_reviewer_dashboard,node_operator_dashboard,node_owner_dashboard,node_client_task_ui,node_worker_submit_ui,node_review_ui,node_agency_users toneBlue
class node_client_api,node_worker_api,node_review_api,node_operator_api,node_task_routes,node_task_controller,node_task_service,node_review_controller,node_review_service,node_dashboard_controller,node_dashboard_service toneAmber
class node_payment_ui,node_worker_payout_ui,node_payment_routes,node_payment_controller,node_payment_service toneMint
class node_auth_routes,node_auth_service,node_user_model,node_server,node_app,node_auth_middleware,node_role_middleware,node_activity toneRose
```

## Components

### Role Dashboards

- [Dashboard routing](https://github.com/sireluke/relayworks/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Client dashboard](https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/client/clientdashboard.tsx): `frontend/src/pages/client/clientdashboard.tsx`
- [Worker dashboard](https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/worker/WorkerDashboard.tsx): `frontend/src/pages/worker/WorkerDashboard.tsx`
- [Reviewer dashboard](https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/reviewer/ReviewerDashboard.tsx): `frontend/src/pages/reviewer/ReviewerDashboard.tsx`
- [Operator dashboard](https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/operator/operatorDashboard.tsx): `frontend/src/pages/operator/operatorDashboard.tsx`
- [Owner dashboard](https://github.com/sireluke/relayworks/blob/main/frontend/src/pages/owner/OwnerDashboard.tsx): `frontend/src/pages/owner/OwnerDashboard.tsx`
- [Task creation](https://github.com/sireluke/relayworks/blob/main/frontend/src/components/client/CreateTaskForm.tsx): `frontend/src/components/client/CreateTaskForm.tsx`
- [Work submission](https://github.com/sireluke/relayworks/blob/main/frontend/src/components/worker/WorkerSubmitPanel.tsx): `frontend/src/components/worker/WorkerSubmitPanel.tsx`
- [Review decisions](https://github.com/sireluke/relayworks/blob/main/frontend/src/components/reviewer/ReviewerApprovalPanel.tsx): `frontend/src/components/reviewer/ReviewerApprovalPanel.tsx`

### Work Coordination

- [Client service](https://github.com/sireluke/relayworks/blob/main/frontend/src/services/clientService.ts): `frontend/src/services/clientService.ts`
- [Worker service](https://github.com/sireluke/relayworks/blob/main/frontend/src/services/workerService.ts): `frontend/src/services/workerService.ts`
- [Reviewer service](https://github.com/sireluke/relayworks/blob/main/frontend/src/services/reviewerService.ts): `frontend/src/services/reviewerService.ts`
- [Operator service](https://github.com/sireluke/relayworks/blob/main/frontend/src/services/operatorService.ts): `frontend/src/services/operatorService.ts`
- [Task routes](https://github.com/sireluke/relayworks/blob/main/backend/src/routes/task.routes.ts): `backend/src/routes/task.routes.ts`
- [Task controller](https://github.com/sireluke/relayworks/blob/main/backend/src/controllers/taskController.ts): `backend/src/controllers/taskController.ts`
- [Task operations](https://github.com/sireluke/relayworks/blob/main/backend/src/services/taskService.ts): `backend/src/services/taskService.ts`
- [Review controller](https://github.com/sireluke/relayworks/blob/main/backend/src/controllers/reviewerController.ts): `backend/src/controllers/reviewerController.ts`
- [Review metrics](https://github.com/sireluke/relayworks/blob/main/backend/src/services/reviewerService.ts): `backend/src/services/reviewerService.ts`
- [Dashboard controller](https://github.com/sireluke/relayworks/blob/main/dashboard.controller.ts): `dashboard.controller.ts`
- [Dashboard service](https://github.com/sireluke/relayworks/blob/main/dashboard.service.ts): `dashboard.service.ts`

### Payments and Account

- [Payment views](https://github.com/sireluke/relayworks/blob/main/frontend/src/components/client/InvoicePanel.tsx): `frontend/src/components/client/InvoicePanel.tsx`
- [Worker payouts](https://github.com/sireluke/relayworks/blob/main/frontend/src/components/worker/WorkerPayoutPanel.tsx): `frontend/src/components/worker/WorkerPayoutPanel.tsx`
- [Payment routes](https://github.com/sireluke/relayworks/blob/main/payment.routes.ts): `payment.routes.ts`
- [Payment controller](https://github.com/sireluke/relayworks/blob/main/payment.controller.ts): `payment.controller.ts`
- [Payment operations](https://github.com/sireluke/relayworks/blob/main/payment.service.ts): `payment.service.ts`

### Backend Platform

- [Login and registration](https://github.com/sireluke/relayworks/blob/main/backend/src/routes/authRoutes.ts): `backend/src/routes/authRoutes.ts`
- [Authentication service](https://github.com/sireluke/relayworks/blob/main/backend/src/services/AuthService.ts): `backend/src/services/AuthService.ts`
- [User record](https://github.com/sireluke/relayworks/blob/main/backend/src/models/User.ts): `backend/src/models/User.ts`
- [HTTP server](https://github.com/sireluke/relayworks/blob/main/backend/src/server.ts): `backend/src/server.ts`
- [Express app](https://github.com/sireluke/relayworks/blob/main/backend/src/app.ts): `backend/src/app.ts`
- [Authentication middleware](https://github.com/sireluke/relayworks/blob/main/backend/src/middleware/auth.middleware.ts): `backend/src/middleware/auth.middleware.ts`
- [Role middleware](https://github.com/sireluke/relayworks/blob/main/backend/src/middleware/role.middleware.ts): `backend/src/middleware/role.middleware.ts`
- [Activity tracking](https://github.com/sireluke/relayworks/blob/main/activity.service.ts): `activity.service.ts`

### Other components

- **Agency users**

## Connections

- Agency users → Dashboard routing: choose role view (evidence: `frontend/src/App.tsx`)
- Dashboard routing → Client dashboard: routes to (evidence: `frontend/src/App.tsx`)
- Dashboard routing → Worker dashboard: routes to (evidence: `frontend/src/App.tsx`)
- Dashboard routing → Reviewer dashboard: routes to (evidence: `frontend/src/App.tsx`)
- Dashboard routing → Operator dashboard: routes to (evidence: `frontend/src/App.tsx`)
- Dashboard routing → Owner dashboard: routes to (evidence: `frontend/src/App.tsx`)
- Client dashboard → Client service: loads overview (evidence: `frontend/src/pages/client/clientdashboard.tsx`)
- Client dashboard → Task creation: renders (evidence: `frontend/src/pages/client/clientdashboard.tsx`)
- Task creation → Client service: creates task (evidence: `frontend/src/components/client/CreateTaskForm.tsx`)
- Worker dashboard → Worker service: loads overview (evidence: `frontend/src/pages/worker/WorkerDashboard.tsx`)
- Worker dashboard → Work submission: renders (evidence: `frontend/src/pages/worker/WorkerDashboard.tsx`)
- Work submission → Worker service: submits work (evidence: `frontend/src/components/worker/WorkerSubmitPanel.tsx`)
- Reviewer dashboard → Reviewer service: loads overview (evidence: `frontend/src/pages/reviewer/ReviewerDashboard.tsx`)
- Reviewer dashboard → Review decisions: renders (evidence: `frontend/src/pages/reviewer/ReviewerDashboard.tsx`)
- Review decisions → Reviewer service: sends decisions (evidence: `frontend/src/components/reviewer/ReviewerApprovalPanel.tsx`)
- Operator dashboard → Operator service: loads task data
- Client service → Task routes: requests task endpoints
- Worker service → Task routes: requests task endpoints
- Reviewer service → Task routes: requests review endpoints
- HTTP server → Task routes: mounts routes (evidence: `backend/src/server.ts`)
- Task routes → Authentication middleware: checks authentication (evidence: `backend/src/routes/task.routes.ts`)
- Task controller → Task operations: delegates task work (evidence: `backend/src/controllers/taskController.ts`)
- Review controller → Review metrics: loads dashboard (evidence: `backend/src/controllers/reviewerController.ts`)
- Review metrics → Agency users: counts review state
- Dashboard controller → Dashboard service: loads dashboard data (evidence: `dashboard.controller.ts`)
- Payment views → Client service: loads invoices (evidence: `frontend/src/services/clientService.ts`)
- Worker payouts → Worker service: loads payouts (evidence: `frontend/src/services/workerService.ts`)
- Payment routes → Payment controller: dispatches requests (evidence: `payment.routes.ts`)
- Payment controller → Payment operations: creates and records (evidence: `payment.controller.ts`)
- Login and registration → Authentication service: checks credentials (evidence: `backend/src/routes/authRoutes.ts`)
- Authentication service → User record: uses user model (evidence: `backend/src/services/AuthService.ts`)
- Express app → Authentication middleware: configures middleware (evidence: `backend/src/app.ts`)
- Express app → Role middleware: configures middleware (evidence: `backend/src/app.ts`)
- Role middleware → Authentication middleware: uses identity (evidence: `backend/src/middleware/role.middleware.ts`)
