# chirag-codex/rate-limiter architecture

> Architecture diagram of the GitHub repository chirag-codex/rate-limiter, 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/chirag-codex/rate-limiter
- Repository: https://github.com/chirag-codex/rate-limiter

## Overview

RateGuard is a multi-tenant rate-limiting service with a React developer dashboard and an Express API. The main workflow is: a developer registers and signs in, creates a project and obtains its API key, then an integrating service submits a client ID and that key to the public check endpoint. The endpoint validates the project, atomically updates that client’s token bucket, records project counters, and returns an allow/deny result. The dashboard also exposes project management and an endpoint test bench; demo routes provide sample limited endpoints. Arrows reflect shown calls or README-documented relationships; unsampled behavior is not inferred.

Main entry points: [`client/src/App.jsx`](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/App.jsx) (Dashboard routes), [`client/src/lib/api.js`](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/lib/api.js) (API URL helper), [`server/src/index.js`](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/index.js) (Express API), [`server/src/controllers/v1Controller.js`](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/controllers/v1Controller.js) (Check controller)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_dashboard["Developer dashboard"]
  node_app["Dashboard routes<br/>[App.jsx]"]
  node_authstate["Auth state<br/>[AuthContext.jsx]"]
  node_login["Sign in<br/>[LoginPage.jsx]"]
  node_register["Registration<br/>[RegisterPage.jsx]"]
  node_projectlist["Project list<br/>[ProjectsPage.jsx]"]
  node_projectdetail["Project details"]
  node_testbench["Endpoint test bench"]
  node_apiurl["API URL helper<br/>[api.js]"]
end

subgraph group_gateway["API gateway"]
  node_server["Express API<br/>[index.js]"]
  node_authroutes["Auth routes<br/>[authRoutes.js]"]
  node_projectroutes["Project routes<br/>[projectRoutes.js]"]
  node_v1routes["Check routes<br/>[v1Routes.js]"]
  node_demoroutes["Demo routes<br/>[demoRoutes.js]"]
end

subgraph group_projects["Accounts and projects"]
  node_authcontroller["Auth controller<br/>[authController.js]"]
  node_user[("User records<br/>[User.js]")]
  node_protect["JWT protection<br/>[protectRoute.js]"]
  node_projectcontroller["Project controller"]
  node_project[("Project records<br/>[Project.js]")]
end

subgraph group_limiting["Rate limiting"]
  node_checkcontroller["Check controller<br/>[v1Controller.js]"]
  node_bucketservice["Atomic bucket service<br/>[bucketService.js]"]
  node_bucket[("Token buckets<br/>[Bucket.js]")]
  node_ratemiddleware["Demo limiter<br/>[rateLimiter.js]"]
  node_clientvalidation["Client ID validation"]
end

node_developer(("Developer"))
node_integrator(("Integrating service"))

node_developer -.->|"uses"| node_app
node_app -->|"routes to"| node_login
node_app -->|"routes to"| node_register
node_app -->|"routes to"| node_projectlist
node_app -->|"routes to"| node_projectdetail
node_app -->|"routes to"| node_testbench
node_login -->|"updates"| node_authstate
node_register -->|"updates"| node_authstate
node_login -->|"requests via"| node_apiurl
node_register -->|"requests via"| node_apiurl
node_projectlist -->|"requests via"| node_apiurl
node_projectdetail -->|"requests via"| node_apiurl
node_testbench -->|"requests via"| node_apiurl
node_apiurl -.->|"sends HTTP"| node_server
node_server -->|"mounts"| node_authroutes
node_server -->|"mounts"| node_projectroutes
node_server -->|"mounts"| node_v1routes
node_server -->|"mounts"| node_demoroutes
node_authroutes -->|"dispatches"| node_authcontroller
node_projectroutes -->|"dispatches"| node_projectcontroller
node_projectroutes -->|"applies"| node_protect
node_authcontroller -->|"reads and writes"| node_user
node_projectcontroller -->|"reads and writes"| node_project
node_projectcontroller -->|"deletes buckets"| node_bucket
node_v1routes -->|"dispatches"| node_checkcontroller
node_integrator -->|"submits check"| node_checkcontroller
node_checkcontroller -->|"validates key; updates counts"| node_project
node_checkcontroller -->|"checks limit"| node_bucketservice
node_bucketservice -->|"atomically updates"| node_bucket
node_demoroutes -->|"applies limits"| node_ratemiddleware
node_ratemiddleware -->|"uses"| node_bucketservice
node_ratemiddleware -->|"uses"| node_clientvalidation

click node_app "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/App.jsx"
click node_authstate "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/context/AuthContext.jsx"
click node_login "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/LoginPage.jsx"
click node_register "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/RegisterPage.jsx"
click node_projectlist "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/ProjectsPage.jsx"
click node_projectdetail "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/ProjectDetailPage.jsx"
click node_testbench "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/Testendpointpage.jsx"
click node_apiurl "https://github.com/chirag-codex/rate-limiter/blob/main/client/src/lib/api.js"
click node_server "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/index.js"
click node_authroutes "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/authRoutes.js"
click node_projectroutes "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/projectRoutes.js"
click node_v1routes "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/v1Routes.js"
click node_demoroutes "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/demoRoutes.js"
click node_authcontroller "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/controllers/authController.js"
click node_user "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/models/User.js"
click node_protect "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/middleware/protectRoute.js"
click node_projectcontroller "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/controllers/projectController.js"
click node_project "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/models/Project.js"
click node_checkcontroller "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/controllers/v1Controller.js"
click node_bucketservice "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/lib/bucketService.js"
click node_bucket "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/models/Bucket.js"
click node_ratemiddleware "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/middleware/rateLimiter.js"
click node_clientvalidation "https://github.com/chirag-codex/rate-limiter/blob/main/server/src/lib/validateClientId.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_authstate,node_login,node_register,node_projectlist,node_projectdetail,node_testbench,node_apiurl toneBlue
class node_server,node_authroutes,node_projectroutes,node_v1routes,node_demoroutes toneAmber
class node_authcontroller,node_user,node_protect,node_projectcontroller,node_project toneMint
class node_checkcontroller,node_bucketservice,node_bucket,node_ratemiddleware,node_clientvalidation toneRose
class node_developer,node_integrator toneIndigo
```

## Components

### Developer dashboard

- [Dashboard routes](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/App.jsx): `client/src/App.jsx`
- [Auth state](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/context/AuthContext.jsx): `client/src/context/AuthContext.jsx`
- [Sign in](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/LoginPage.jsx): `client/src/pages/LoginPage.jsx`
- [Registration](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/RegisterPage.jsx): `client/src/pages/RegisterPage.jsx`
- [Project list](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/ProjectsPage.jsx): `client/src/pages/ProjectsPage.jsx`
- [Project details](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/ProjectDetailPage.jsx): `client/src/pages/ProjectDetailPage.jsx`
- [Endpoint test bench](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/pages/Testendpointpage.jsx): `client/src/pages/Testendpointpage.jsx`
- [API URL helper](https://github.com/chirag-codex/rate-limiter/blob/main/client/src/lib/api.js): `client/src/lib/api.js`

### API gateway

- [Express API](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/index.js): `server/src/index.js`
- [Auth routes](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/authRoutes.js): `server/src/routes/authRoutes.js`
- [Project routes](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/projectRoutes.js): `server/src/routes/projectRoutes.js`
- [Check routes](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/v1Routes.js): `server/src/routes/v1Routes.js`
- [Demo routes](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/routes/demoRoutes.js): `server/src/routes/demoRoutes.js`

### Accounts and projects

- [Auth controller](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/controllers/authController.js): `server/src/controllers/authController.js`
- [User records](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/models/User.js): `server/src/models/User.js`
- [JWT protection](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/middleware/protectRoute.js): `server/src/middleware/protectRoute.js`
- [Project controller](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/controllers/projectController.js): `server/src/controllers/projectController.js`
- [Project records](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/models/Project.js): `server/src/models/Project.js`

### Rate limiting

- [Check controller](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/controllers/v1Controller.js): `server/src/controllers/v1Controller.js`
- [Atomic bucket service](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/lib/bucketService.js): `server/src/lib/bucketService.js`
- [Token buckets](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/models/Bucket.js): `server/src/models/Bucket.js`
- [Demo limiter](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/middleware/rateLimiter.js): `server/src/middleware/rateLimiter.js`
- [Client ID validation](https://github.com/chirag-codex/rate-limiter/blob/main/server/src/lib/validateClientId.js): `server/src/lib/validateClientId.js`

### Other components

- **Developer**
- **Integrating service**

## Connections

- Developer → Dashboard routes: uses
- Dashboard routes → Sign in: routes to (evidence: `client/src/App.jsx`)
- Dashboard routes → Registration: routes to (evidence: `client/src/App.jsx`)
- Dashboard routes → Project list: routes to (evidence: `client/src/App.jsx`)
- Dashboard routes → Project details: routes to (evidence: `client/src/App.jsx`)
- Dashboard routes → Endpoint test bench: routes to (evidence: `client/src/App.jsx`)
- Sign in → Auth state: updates (evidence: `client/src/pages/LoginPage.jsx`)
- Registration → Auth state: updates (evidence: `client/src/pages/RegisterPage.jsx`)
- Sign in → API URL helper: requests via (evidence: `client/src/pages/LoginPage.jsx`)
- Registration → API URL helper: requests via (evidence: `client/src/pages/RegisterPage.jsx`)
- Project list → API URL helper: requests via (evidence: `client/src/pages/ProjectsPage.jsx`)
- Project details → API URL helper: requests via (evidence: `client/src/pages/ProjectDetailPage.jsx`)
- Endpoint test bench → API URL helper: requests via (evidence: `client/src/pages/Testendpointpage.jsx`)
- API URL helper → Express API: sends HTTP
- Express API → Auth routes: mounts (evidence: `server/src/index.js`)
- Express API → Project routes: mounts (evidence: `server/src/index.js`)
- Express API → Check routes: mounts (evidence: `server/src/index.js`)
- Express API → Demo routes: mounts (evidence: `server/src/index.js`)
- Auth routes → Auth controller: dispatches (evidence: `server/src/routes/authRoutes.js`)
- Project routes → Project controller: dispatches (evidence: `server/src/routes/projectRoutes.js`)
- Project routes → JWT protection: applies (evidence: `server/src/routes/projectRoutes.js`)
- Auth controller → User records: reads and writes (evidence: `server/src/controllers/authController.js`)
- Project controller → Project records: reads and writes (evidence: `server/src/controllers/projectController.js`)
- Project controller → Token buckets: deletes buckets (evidence: `server/src/controllers/projectController.js`)
- Check routes → Check controller: dispatches (evidence: `server/src/routes/v1Routes.js`)
- Integrating service → Check controller: submits check (evidence: `README.md`)
- Check controller → Project records: validates key; updates counts (evidence: `server/src/controllers/v1Controller.js`)
- Check controller → Atomic bucket service: checks limit (evidence: `server/src/controllers/v1Controller.js`)
- Atomic bucket service → Token buckets: atomically updates (evidence: `server/src/lib/bucketService.js`)
- Demo routes → Demo limiter: applies limits (evidence: `server/src/routes/demoRoutes.js`)
- Demo limiter → Atomic bucket service: uses (evidence: `server/src/middleware/rateLimiter.js`)
- Demo limiter → Client ID validation: uses (evidence: `server/src/middleware/rateLimiter.js`)
