# sri-dhran/green-circuit architecture

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

- Interactive diagram: https://gitdiagram.com/sri-dhran/green-circuit
- Repository: https://github.com/sri-dhran/green-circuit

## Overview

Green Circuit is an e-waste pickup platform: users authenticate, choose a collection office, submit and track pickup requests, and can redeem reward points. Office and agent dashboards manage requests and collection; administrators have global analytics. The map preserves the README’s major product capabilities, with backend services and frontend role dashboards as the main layers. Several backend controllers and analytics/notification implementations were not sampled, so those subsystem links rely on the README’s module descriptions rather than inspected call sites.

Main entry points: [`frontend/src/common/api/axiosConfig.js`](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/common/api/axiosConfig.js) (Authenticated API client), [`frontend/src/App.jsx`](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/App.jsx) (Role dashboards), [`backend/src/main/java/com/greencircuit/backend/modules/user/service/AuthService.java`](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/user/service/AuthService.java) (Authentication), [`backend/src/main/java/com/greencircuit/backend/modules/pickup/service/PickupRequestService.java`](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/pickup/service/PickupRequestService.java) (Pickup workflow)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["Identity &amp; Access"]
  node_app["Role dashboards<br/>[App.jsx]"]
  node_auth["Authentication<br/>[AuthService.java]"]
  node_user_profile["User profiles<br/>[UserService.java]"]
  node_user_store[("User records<br/>[User.java]")]
  node_api_client["Authenticated API client<br/>[axiosConfig.js]"]
end

subgraph group_operations["Pickup Operations"]
  node_offices["Collection offices<br/>[OfficeService.java]"]
  node_office_ui["Office dashboard"]
  node_pickup_ui["User pickup dashboard<br/>[UserDashboard.jsx]"]
  node_pickup_form["Pickup request form"]
  node_pickup_service["Pickup workflow"]
  node_pickup_store[("Pickup requests<br/>[PickupRequest.java]")]
  node_agent_service["Agent management"]
  node_agent_ui["Agent dashboard<br/>[AgentDashboard.jsx]"]
end

subgraph group_engagement["Rewards &amp; Messaging"]
  node_rewards_ui["Reward store<br/>[RewardStore.jsx]"]
  node_reward_service["Reward redemption<br/>[RewardService.java]"]
  node_reward_store[("Reward records")]
  node_notifications["Notifications &amp; email"]
end

subgraph group_oversight["Administration &amp; Analytics"]
  node_admin_ui["Admin dashboard"]
  node_analytics["Global analytics"]
end

node_user(("Platform user"))

node_user -->|"uses"| node_app
node_app -->|"routes to"| node_auth
node_app -->|"routes to"| node_office_ui
node_app -->|"routes to"| node_pickup_ui
node_app -->|"routes to"| node_agent_ui
node_app -->|"routes to"| node_rewards_ui
node_app -->|"routes to"| node_admin_ui
node_auth -->|"reads and writes"| node_user_store
node_auth -->|"looks up office"| node_offices
node_pickup_ui -.->|"includes"| node_pickup_form
node_pickup_form -.->|"submits requests"| node_api_client
node_office_ui -.->|"manages offices"| node_api_client
node_agent_ui -.->|"manages collections"| node_api_client
node_rewards_ui -.->|"requests rewards"| node_api_client
node_admin_ui -.->|"requests analytics"| node_api_client
node_api_client -.->|"calls backend"| node_pickup_service
node_api_client -.->|"calls backend"| node_offices
node_api_client -.->|"calls backend"| node_agent_service
node_api_client -.->|"calls backend"| node_reward_service
node_api_client -.->|"calls backend"| node_analytics
node_pickup_service -->|"saves requests"| node_pickup_store
node_pickup_service -->|"creates notifications"| node_notifications
node_agent_service -->|"creates notifications"| node_notifications
node_reward_service -->|"updates points"| node_user_store
node_reward_service -->|"saves redemption"| node_reward_store
node_analytics -.->|"reports on"| node_pickup_store

click node_app "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/App.jsx"
click node_auth "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/user/service/AuthService.java"
click node_user_profile "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/user/service/UserService.java"
click node_user_store "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/user/entity/User.java"
click node_offices "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/center/service/OfficeService.java"
click node_office_ui "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/center/pages/OfficeDashboard.jsx"
click node_pickup_ui "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/pickup/pages/UserDashboard.jsx"
click node_pickup_form "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/pickup/components/PickupRequestForm.jsx"
click node_pickup_service "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/pickup/service/PickupRequestService.java"
click node_pickup_store "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/pickup/entity/PickupRequest.java"
click node_agent_service "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/agent/service/CollectionAgentService.java"
click node_agent_ui "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/agent/pages/AgentDashboard.jsx"
click node_rewards_ui "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/reward/pages/RewardStore.jsx"
click node_reward_service "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/reward/service/RewardService.java"
click node_reward_store "https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/reward/entity/RewardRedemption.java"
click node_notifications "https://github.com/sri-dhran/green-circuit/tree/main/backend/src/main/java/com/greencircuit/backend/modules/notification"
click node_admin_ui "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/analytics/pages/SuperAdminDashboard.jsx"
click node_analytics "https://github.com/sri-dhran/green-circuit/tree/main/backend/src/main/java/com/greencircuit/backend/modules/analytics"
click node_api_client "https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/common/api/axiosConfig.js"

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_auth,node_user_profile,node_user_store,node_api_client,node_user toneBlue
class node_offices,node_office_ui,node_pickup_ui,node_pickup_form,node_pickup_service,node_pickup_store,node_agent_service,node_agent_ui toneAmber
class node_rewards_ui,node_reward_service,node_reward_store,node_notifications toneMint
class node_admin_ui,node_analytics toneRose
```

## Components

### Identity & Access

- [Role dashboards](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Authentication](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/user/service/AuthService.java): `backend/src/main/java/com/greencircuit/backend/modules/user/service/AuthService.java`
- [User profiles](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/user/service/UserService.java): `backend/src/main/java/com/greencircuit/backend/modules/user/service/UserService.java`
- [User records](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/user/entity/User.java): `backend/src/main/java/com/greencircuit/backend/modules/user/entity/User.java`
- [Authenticated API client](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/common/api/axiosConfig.js): `frontend/src/common/api/axiosConfig.js`

### Pickup Operations

- [Collection offices](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/center/service/OfficeService.java): `backend/src/main/java/com/greencircuit/backend/modules/center/service/OfficeService.java`
- [Office dashboard](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/center/pages/OfficeDashboard.jsx): `frontend/src/modules/center/pages/OfficeDashboard.jsx`
- [User pickup dashboard](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/pickup/pages/UserDashboard.jsx): `frontend/src/modules/pickup/pages/UserDashboard.jsx`
- [Pickup request form](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/pickup/components/PickupRequestForm.jsx): `frontend/src/modules/pickup/components/PickupRequestForm.jsx`
- [Pickup workflow](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/pickup/service/PickupRequestService.java): `backend/src/main/java/com/greencircuit/backend/modules/pickup/service/PickupRequestService.java`
- [Pickup requests](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/pickup/entity/PickupRequest.java): `backend/src/main/java/com/greencircuit/backend/modules/pickup/entity/PickupRequest.java`
- [Agent management](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/agent/service/CollectionAgentService.java): `backend/src/main/java/com/greencircuit/backend/modules/agent/service/CollectionAgentService.java`
- [Agent dashboard](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/agent/pages/AgentDashboard.jsx): `frontend/src/modules/agent/pages/AgentDashboard.jsx`

### Rewards & Messaging

- [Reward store](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/reward/pages/RewardStore.jsx): `frontend/src/modules/reward/pages/RewardStore.jsx`
- [Reward redemption](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/reward/service/RewardService.java): `backend/src/main/java/com/greencircuit/backend/modules/reward/service/RewardService.java`
- [Reward records](https://github.com/sri-dhran/green-circuit/blob/main/backend/src/main/java/com/greencircuit/backend/modules/reward/entity/RewardRedemption.java): `backend/src/main/java/com/greencircuit/backend/modules/reward/entity/RewardRedemption.java`
- [Notifications & email](https://github.com/sri-dhran/green-circuit/tree/main/backend/src/main/java/com/greencircuit/backend/modules/notification): `backend/src/main/java/com/greencircuit/backend/modules/notification`

### Administration & Analytics

- [Admin dashboard](https://github.com/sri-dhran/green-circuit/blob/main/frontend/src/modules/analytics/pages/SuperAdminDashboard.jsx): `frontend/src/modules/analytics/pages/SuperAdminDashboard.jsx`
- [Global analytics](https://github.com/sri-dhran/green-circuit/tree/main/backend/src/main/java/com/greencircuit/backend/modules/analytics): `backend/src/main/java/com/greencircuit/backend/modules/analytics`

### Other components

- **Platform user**

## Connections

- Platform user → Role dashboards: uses (evidence: `frontend/src/App.jsx`)
- Role dashboards → Authentication: routes to (evidence: `frontend/src/App.jsx`)
- Role dashboards → Office dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Role dashboards → User pickup dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Role dashboards → Agent dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Role dashboards → Reward store: routes to (evidence: `frontend/src/App.jsx`)
- Role dashboards → Admin dashboard: routes to (evidence: `frontend/src/App.jsx`)
- Authentication → User records: reads and writes (evidence: `backend/src/main/java/com/greencircuit/backend/modules/user/service/AuthService.java`)
- Authentication → Collection offices: looks up office (evidence: `backend/src/main/java/com/greencircuit/backend/modules/user/service/AuthService.java`)
- User pickup dashboard → Pickup request form: includes (evidence: `README.md`)
- Pickup request form → Authenticated API client: submits requests (evidence: `README.md`)
- Office dashboard → Authenticated API client: manages offices (evidence: `README.md`)
- Agent dashboard → Authenticated API client: manages collections (evidence: `README.md`)
- Reward store → Authenticated API client: requests rewards (evidence: `README.md`)
- Admin dashboard → Authenticated API client: requests analytics (evidence: `README.md`)
- Authenticated API client → Pickup workflow: calls backend (evidence: `README.md`)
- Authenticated API client → Collection offices: calls backend (evidence: `README.md`)
- Authenticated API client → Agent management: calls backend (evidence: `README.md`)
- Authenticated API client → Reward redemption: calls backend (evidence: `README.md`)
- Authenticated API client → Global analytics: calls backend (evidence: `README.md`)
- Pickup workflow → Pickup requests: saves requests (evidence: `backend/src/main/java/com/greencircuit/backend/modules/pickup/service/PickupRequestService.java`)
- Pickup workflow → Notifications & email: creates notifications (evidence: `backend/src/main/java/com/greencircuit/backend/modules/pickup/service/PickupRequestService.java`)
- Agent management → Notifications & email: creates notifications (evidence: `backend/src/main/java/com/greencircuit/backend/modules/agent/service/CollectionAgentService.java`)
- Reward redemption → User records: updates points (evidence: `backend/src/main/java/com/greencircuit/backend/modules/reward/service/RewardService.java`)
- Reward redemption → Reward records: saves redemption (evidence: `backend/src/main/java/com/greencircuit/backend/modules/reward/service/RewardService.java`)
- Global analytics → Pickup requests: reports on (evidence: `README.md`)
