# nandurpm/diploma-notes architecture

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

- Interactive diagram: https://gitdiagram.com/nandurpm/diploma-notes
- Repository: https://github.com/nandurpm/diploma-notes

## Overview

POLY PMNA is a static-first learning platform for Kerala Polytechnic students, with a public study site, an Ask POLY backend, and an Android wrapper. The primary workflow is students accessing curriculum materials through the site or app; Ask POLY separately handles questions, PDF searches, and mock-exam evaluation. The README documents additional quiz, historical-material, student-tool, and offline capabilities, but their site implementations are not in the supplied excerpts. Edges are limited to shown imports/calls or README-documented behavior; unsampled site links are omitted.

Main entry points: [`android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java`](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java) (Android WebView app), [`workers/ask-poly-ai/src/ask-handler.js`](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/ask-handler.js) (Ask handler), [`workers/ask-poly-ai/src/index.js`](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/index.js) (Worker routes), [`workers/ask-poly-ai/src/mock-evaluator.js`](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/mock-evaluator.js) (Mock evaluator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_public["Learning site"]
  node_public_site["Study portals"]
  node_curriculum["Curriculum materials"]
  node_historical["Historical materials"]
  node_study_tools["Student tools"]
end

subgraph group_assistant["Ask POLY services"]
  node_ai_api["Worker routes<br/>[index.js]"]
  node_ask_handler["Ask handler<br/>[ask-handler.js]"]
  node_pdf_intent["PDF intent parser"]
  node_pdf_search["PDF search<br/>[pdf-search.js]"]
  node_pdf_archive["PDF archive"]
  node_language["Language policy<br/>[language-policy.js]"]
  node_http["HTTP utilities<br/>[http.js]"]
  node_faq_data["FAQ data<br/>[faq-data.js]"]
  node_faq_match["FAQ matching<br/>[faq-match.js]"]
  node_mock_eval["Mock evaluator<br/>[mock-evaluator.js]"]
  node_mock_paper["Mock paper logic<br/>[mock-paper.js]"]
  node_mock_papers["Mock paper data<br/>[mock-papers.js]"]
  node_quiz["Daily quiz<br/>[daily-quiz.js]"]
end

subgraph group_android["Android app"]
  node_android_app["Android WebView app<br/>[MainActivity.java]"]
  node_bookmarks["Bookmarks"]
  node_offline_cache[("Offline page cache")]
  node_saved_pages["Saved pages"]
  node_update_gate["Update gate<br/>[ForceUpdateGate.kt]"]
  node_notifications["Push notifications"]
  node_notification_setup["Notification setup"]
end

subgraph group_support["Platform capabilities"]
  node_pwa["Offline PWA<br/>[sw.js]"]
end

node_student(("Student"))
node_firebase(("Firebase messaging"))

node_student -->|"browses"| node_public_site
node_student -->|"uses"| node_android_app
node_student -->|"asks questions"| node_ai_api
node_public_site -->|"serves"| node_curriculum
node_public_site -->|"serves"| node_historical
node_public_site -->|"offers"| node_study_tools
node_public_site -->|"supports offline"| node_pwa
node_ai_api -->|"dispatches"| node_ask_handler
node_ai_api -->|"dispatches"| node_mock_eval
node_ai_api -->|"uses"| node_faq_match
node_ask_handler -->|"parses requests"| node_pdf_intent
node_ask_handler -->|"searches index"| node_pdf_search
node_ask_handler -->|"resolves language"| node_language
node_ask_handler -->|"cleans text"| node_http
node_pdf_intent -->|"cleans input"| node_http
node_pdf_search -->|"returns archive links"| node_pdf_archive
node_faq_match -->|"matches against"| node_faq_data
node_mock_eval -->|"uses"| node_mock_paper
node_mock_eval -->|"uses"| node_mock_papers
node_android_app -->|"manages"| node_bookmarks
node_android_app -->|"manages"| node_offline_cache
node_android_app -->|"opens"| node_saved_pages
node_android_app -->|"checks updates"| node_update_gate
node_saved_pages -->|"lists and removes"| node_bookmarks
node_saved_pages -->|"lists and removes"| node_offline_cache
node_firebase -.->|"delivers messages"| node_notifications
node_notifications -->|"opens lesson links"| node_android_app
node_notification_setup -->|"launches"| node_android_app
node_notification_setup -->|"subscribes topics"| node_firebase

click node_pwa "https://github.com/nandurpm/diploma-notes/blob/main/sw.js"
click node_ai_api "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/index.js"
click node_ask_handler "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/ask-handler.js"
click node_pdf_intent "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/pdf-intent-parser.js"
click node_pdf_search "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/pdf-search.js"
click node_language "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/language-policy.js"
click node_http "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/http.js"
click node_faq_data "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/faq-data.js"
click node_faq_match "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/faq-match.js"
click node_mock_eval "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/mock-evaluator.js"
click node_mock_paper "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/mock-paper.js"
click node_mock_papers "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/mock-papers.js"
click node_quiz "https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/daily-quiz.js"
click node_android_app "https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java"
click node_bookmarks "https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/BookmarkManager.java"
click node_offline_cache "https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/OfflineCacheManager.java"
click node_saved_pages "https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/SavedPagesActivity.java"
click node_update_gate "https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/ForceUpdateGate.kt"
click node_notifications "https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/PolyPmnaMessagingService.java"
click node_notification_setup "https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/NotificationBootstrapActivity.java"

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_public_site,node_curriculum,node_historical,node_study_tools toneBlue
class node_ai_api,node_ask_handler,node_pdf_intent,node_pdf_search,node_pdf_archive,node_language,node_http,node_faq_data,node_faq_match,node_mock_eval,node_mock_paper,node_mock_papers,node_quiz toneAmber
class node_android_app,node_bookmarks,node_offline_cache,node_saved_pages,node_update_gate,node_notifications,node_notification_setup toneMint
class node_pwa toneRose
class node_student,node_firebase toneIndigo
```

## Components

### Learning site

- **Study portals**
- **Curriculum materials**
- **Historical materials**
- **Student tools**

### Ask POLY services

- [Worker routes](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/index.js): `workers/ask-poly-ai/src/index.js`
- [Ask handler](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/ask-handler.js): `workers/ask-poly-ai/src/ask-handler.js`
- [PDF intent parser](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/pdf-intent-parser.js): `workers/ask-poly-ai/src/pdf-intent-parser.js`
- [PDF search](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/pdf-search.js): `workers/ask-poly-ai/src/pdf-search.js`
- **PDF archive**
- [Language policy](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/language-policy.js): `workers/ask-poly-ai/src/language-policy.js`
- [HTTP utilities](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/http.js): `workers/ask-poly-ai/src/http.js`
- [FAQ data](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/faq-data.js): `workers/ask-poly-ai/src/faq-data.js`
- [FAQ matching](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/faq-match.js): `workers/ask-poly-ai/src/faq-match.js`
- [Mock evaluator](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/mock-evaluator.js): `workers/ask-poly-ai/src/mock-evaluator.js`
- [Mock paper logic](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/mock-paper.js): `workers/ask-poly-ai/src/mock-paper.js`
- [Mock paper data](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/mock-papers.js): `workers/ask-poly-ai/src/mock-papers.js`
- [Daily quiz](https://github.com/nandurpm/diploma-notes/blob/main/workers/ask-poly-ai/src/daily-quiz.js): `workers/ask-poly-ai/src/daily-quiz.js`

### Android app

- [Android WebView app](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java): `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java`
- [Bookmarks](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/BookmarkManager.java): `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/BookmarkManager.java`
- [Offline page cache](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/OfflineCacheManager.java): `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/OfflineCacheManager.java`
- [Saved pages](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/SavedPagesActivity.java): `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/SavedPagesActivity.java`
- [Update gate](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/ForceUpdateGate.kt): `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/ForceUpdateGate.kt`
- [Push notifications](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/PolyPmnaMessagingService.java): `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/PolyPmnaMessagingService.java`
- [Notification setup](https://github.com/nandurpm/diploma-notes/blob/main/android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/NotificationBootstrapActivity.java): `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/NotificationBootstrapActivity.java`

### Platform capabilities

- [Offline PWA](https://github.com/nandurpm/diploma-notes/blob/main/sw.js): `sw.js`

### Other components

- **Student**
- **Firebase messaging**

## Connections

- Student → Study portals: browses (evidence: `README.md`)
- Student → Android WebView app: uses (evidence: `README.md`)
- Student → Worker routes: asks questions (evidence: `README.md`)
- Study portals → Curriculum materials: serves (evidence: `README.md`)
- Study portals → Historical materials: serves (evidence: `README.md`)
- Study portals → Student tools: offers (evidence: `README.md`)
- Study portals → Offline PWA: supports offline (evidence: `README.md`)
- Worker routes → Ask handler: dispatches (evidence: `workers/ask-poly-ai/src/index.js`)
- Worker routes → Mock evaluator: dispatches (evidence: `workers/ask-poly-ai/src/index.js`)
- Worker routes → FAQ matching: uses (evidence: `workers/ask-poly-ai/src/index.js`)
- Ask handler → PDF intent parser: parses requests (evidence: `workers/ask-poly-ai/src/ask-handler.js`)
- Ask handler → PDF search: searches index (evidence: `workers/ask-poly-ai/src/ask-handler.js`)
- Ask handler → Language policy: resolves language (evidence: `workers/ask-poly-ai/src/ask-handler.js`)
- Ask handler → HTTP utilities: cleans text (evidence: `workers/ask-poly-ai/src/ask-handler.js`)
- PDF intent parser → HTTP utilities: cleans input (evidence: `workers/ask-poly-ai/src/pdf-intent-parser.js`)
- PDF search → PDF archive: returns archive links (evidence: `workers/ask-poly-ai/src/pdf-search.js`)
- FAQ matching → FAQ data: matches against (evidence: `workers/ask-poly-ai/src/faq-match.js`)
- Mock evaluator → Mock paper logic: uses (evidence: `workers/ask-poly-ai/src/mock-evaluator.js`)
- Mock evaluator → Mock paper data: uses (evidence: `workers/ask-poly-ai/src/mock-evaluator.js`)
- Android WebView app → Bookmarks: manages (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java`)
- Android WebView app → Offline page cache: manages (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java`)
- Android WebView app → Saved pages: opens (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java`)
- Android WebView app → Update gate: checks updates (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/MainActivity.java`)
- Saved pages → Bookmarks: lists and removes (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/SavedPagesActivity.java`)
- Saved pages → Offline page cache: lists and removes (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/SavedPagesActivity.java`)
- Firebase messaging → Push notifications: delivers messages
- Push notifications → Android WebView app: opens lesson links (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/PolyPmnaMessagingService.java`)
- Notification setup → Android WebView app: launches (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/NotificationBootstrapActivity.java`)
- Notification setup → Firebase messaging: subscribes topics (evidence: `android-app/app/src/main/java/org/diplomanotes/polytechnicstudyhub/NotificationBootstrapActivity.java`)
