# sanjay-n-01/planner architecture

> Architecture diagram of the GitHub repository sanjay-n-01/planner, 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/sanjay-n-01/planner
- Repository: https://github.com/sanjay-n-01/planner

## Overview

Planner is a single-user study and productivity dashboard. A user works with daily tasks, backlog, roadmap, GATE preparation, notes, and progress tracking in the React app; the app persists state locally and synchronizes it through an Express API to MongoDB. The README documents recovery, snapshot import/export, rollover, and evening reminders as additional capabilities. The main UI is a large, combined component, so feature nodes share its source path. Some optional feature wiring is documented rather than visible in the excerpts.

Main entry points: [`frontend/src/App.tsx`](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx) (Planner dashboard), [`frontend/src/main.tsx`](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/main.tsx) (React entry), [`backend/src/app.js`](https://github.com/sanjay-n-01/planner/blob/main/backend/src/app.js) (Express application), [`backend/src/index.js`](https://github.com/sanjay-n-01/planner/blob/main/backend/src/index.js) (API startup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Planner interface"]
  node_app_entry["React entry<br/>[main.tsx]"]
  node_dashboard["Planner dashboard<br/>[App.tsx]"]
  node_daily["Daily planning<br/>[App.tsx]"]
  node_backlog["Task backlog<br/>[App.tsx]"]
  node_roadmap["Learning roadmap<br/>[App.tsx]"]
  node_gate["GATE preparation<br/>[App.tsx]"]
  node_scores["Mock score tracking<br/>[App.tsx]"]
  node_notes["Notes and memos<br/>[App.tsx]"]
  node_recovery["Recovery and snapshots<br/>[App.tsx]"]
  node_rollover["Daily rollover<br/>[App.tsx]"]
  node_api_client["State API client<br/>[api.js]"]
end

subgraph group_backend["State API"]
  node_api_app["Express application<br/>[app.js]"]
  node_state_routes["State routes<br/>[state.route.js]"]
  node_state_controller["State controller"]
  node_api_entry["API startup<br/>[index.js]"]
end

subgraph group_persistence["State persistence"]
  node_browser_cache[("Browser localStorage")]
  node_state_model["Application state model<br/>[state.model.js]"]
  node_mongo[("MongoDB Atlas")]
  node_db_connector["Database connector<br/>[database.js]"]
end

subgraph group_reminders["Reminders"]
  node_reminder_logic["Evening reminder<br/>[App.tsx]"]
  node_service_worker["Notification worker<br/>[sw.js]"]
  node_browser_notifications["Browser notifications"]
end

node_user(("Planner user"))

node_user -->|"opens dashboard"| node_app_entry
node_app_entry -->|"renders"| node_dashboard
node_dashboard -->|"loads and saves"| node_api_client
node_dashboard -->|"caches state"| node_browser_cache
node_dashboard -->|"manages tasks"| node_daily
node_dashboard -->|"manages tasks"| node_backlog
node_dashboard -->|"manages milestones"| node_roadmap
node_dashboard -->|"tracks preparation"| node_gate
node_dashboard -->|"records scores"| node_scores
node_dashboard -->|"edits notes"| node_notes
node_dashboard -->|"supports recovery"| node_recovery
node_dashboard -->|"rolls unfinished tasks"| node_rollover
node_api_client -->|"requests state"| node_api_app
node_api_app -->|"mounts routes"| node_state_routes
node_state_routes -->|"dispatches requests"| node_state_controller
node_state_controller -->|"reads and replaces"| node_state_model
node_state_model -->|"persists state"| node_mongo
node_api_entry -->|"starts server"| node_api_app
node_api_entry -->|"connects database"| node_db_connector
node_db_connector -->|"connects to"| node_mongo
node_dashboard -.->|"checks reminders"| node_reminder_logic
node_app_entry -->|"registers"| node_service_worker
node_service_worker -->|"shows notification"| node_browser_notifications

click node_app_entry "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/main.tsx"
click node_dashboard "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_daily "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_backlog "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_roadmap "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_gate "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_scores "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_notes "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_recovery "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_rollover "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_api_client "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/services/api.js"
click node_api_app "https://github.com/sanjay-n-01/planner/blob/main/backend/src/app.js"
click node_state_routes "https://github.com/sanjay-n-01/planner/blob/main/backend/src/routes/state.route.js"
click node_state_controller "https://github.com/sanjay-n-01/planner/blob/main/backend/src/controllers/state.controller.js"
click node_state_model "https://github.com/sanjay-n-01/planner/blob/main/backend/src/models/state.model.js"
click node_api_entry "https://github.com/sanjay-n-01/planner/blob/main/backend/src/index.js"
click node_db_connector "https://github.com/sanjay-n-01/planner/blob/main/backend/src/config/database.js"
click node_reminder_logic "https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx"
click node_service_worker "https://github.com/sanjay-n-01/planner/blob/main/frontend/public/sw.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_entry,node_dashboard,node_daily,node_backlog,node_roadmap,node_gate,node_scores,node_notes,node_recovery,node_rollover,node_api_client,node_user toneBlue
class node_api_app,node_state_routes,node_state_controller,node_api_entry toneAmber
class node_browser_cache,node_state_model,node_mongo,node_db_connector toneMint
class node_reminder_logic,node_service_worker,node_browser_notifications toneRose
```

## Components

### Planner interface

- [React entry](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/main.tsx): `frontend/src/main.tsx`
- [Planner dashboard](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Daily planning](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Task backlog](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Learning roadmap](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [GATE preparation](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Mock score tracking](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Notes and memos](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Recovery and snapshots](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Daily rollover](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [State API client](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/services/api.js): `frontend/src/services/api.js`

### State API

- [Express application](https://github.com/sanjay-n-01/planner/blob/main/backend/src/app.js): `backend/src/app.js`
- [State routes](https://github.com/sanjay-n-01/planner/blob/main/backend/src/routes/state.route.js): `backend/src/routes/state.route.js`
- [State controller](https://github.com/sanjay-n-01/planner/blob/main/backend/src/controllers/state.controller.js): `backend/src/controllers/state.controller.js`
- [API startup](https://github.com/sanjay-n-01/planner/blob/main/backend/src/index.js): `backend/src/index.js`

### State persistence

- **Browser localStorage**
- [Application state model](https://github.com/sanjay-n-01/planner/blob/main/backend/src/models/state.model.js): `backend/src/models/state.model.js`
- **MongoDB Atlas**
- [Database connector](https://github.com/sanjay-n-01/planner/blob/main/backend/src/config/database.js): `backend/src/config/database.js`

### Reminders

- [Evening reminder](https://github.com/sanjay-n-01/planner/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Notification worker](https://github.com/sanjay-n-01/planner/blob/main/frontend/public/sw.js): `frontend/public/sw.js`
- **Browser notifications**

### Other components

- **Planner user**

## Connections

- Planner user → React entry: opens dashboard (evidence: `README.md`)
- React entry → Planner dashboard: renders (evidence: `frontend/src/main.tsx`)
- Planner dashboard → State API client: loads and saves (evidence: `frontend/src/App.tsx`)
- Planner dashboard → Browser localStorage: caches state (evidence: `README.md`)
- Planner dashboard → Daily planning: manages tasks (evidence: `README.md`)
- Planner dashboard → Task backlog: manages tasks (evidence: `README.md`)
- Planner dashboard → Learning roadmap: manages milestones (evidence: `README.md`)
- Planner dashboard → GATE preparation: tracks preparation (evidence: `README.md`)
- Planner dashboard → Mock score tracking: records scores (evidence: `README.md`)
- Planner dashboard → Notes and memos: edits notes (evidence: `frontend/src/App.tsx`)
- Planner dashboard → Recovery and snapshots: supports recovery (evidence: `README.md`)
- Planner dashboard → Daily rollover: rolls unfinished tasks (evidence: `README.md`)
- State API client → Express application: requests state (evidence: `README.md`)
- Express application → State routes: mounts routes (evidence: `backend/src/app.js`)
- State routes → State controller: dispatches requests (evidence: `backend/src/routes/state.route.js`)
- State controller → Application state model: reads and replaces (evidence: `backend/src/controllers/state.controller.js`)
- Application state model → MongoDB Atlas: persists state (evidence: `README.md`)
- API startup → Express application: starts server (evidence: `backend/src/index.js`)
- API startup → Database connector: connects database (evidence: `backend/src/index.js`)
- Database connector → MongoDB Atlas: connects to (evidence: `backend/src/config/database.js`)
- Planner dashboard → Evening reminder: checks reminders (evidence: `README.md`)
- React entry → Notification worker: registers (evidence: `frontend/src/main.tsx`)
- Notification worker → Browser notifications: shows notification (evidence: `frontend/public/sw.js`)
