How mpc-ou/mpc-extension works
Project Type and Purpose
• This is a browser extension (Chrome/Chromium-based) built with TypeScript and Vite.
File Structure Analysis
• Top-level: configuration files (.gitignore, tsconfig.json, vite.config.ts), build scripts (scripts/updateManifest.ts), and entry HTML (index.html).
• public/: static assets—extension manifest (manifest.json), Chart.js library, xlsx library, images.
• src/: main TypeScript code.
• app.ts: orchestrator for initialization.
• index.ts: content script entry.
• info.ts & statistics.ts: feature modules for info panel and statistics view.
• constants/: default values, app-wide constants.
• data/: domain data (IT, major curricula).
• utils/: DOM helpers, query utilities, global type declarations.
• css/: styling for base, app, info, statistics views.
• scripts/: utility to update manifest before build.
• package.json & pnpm-lock.yaml: dependencies and scripts.
README Insights
• Uses pnpm for build.
• After build, dist/ contains the extension bundle.
• Loaded as an unpacked extension, injects into https://tienichsv.ou.edu.vn, on the “điểm” tab.
Main Components
a. Content Script (src/index.ts)
b. Core Application Module (src/app.ts)
c. Feature Modules
• Info Panel (src/info.ts + CSS)
• Statistics Dashboard (src/statistics.ts + CSS + Chart.js)
d. Data Layer (src/data/*, src/constants/*)
e. Utility Layer (src/utils/*)
f. Static Asset Providers (Chart.js, xlsx, images in public/)
g. Extension Host (Chrome extension runtime)
h. External Host Page (OU student portal)
Relationships & Interactions
• On page load at target URL, Chrome runtime injects content script.
• Content script → invokes app.ts → initializes data modules & utils.
• app.ts orchestrates rendering:
• Loads data from data layer → passes to feature modules.
• Info module reads DOM via utils → overlays student info panel.
• Statistics module computes GPA, draws charts via Chart.js.
• Feature modules may export to Excel via xlsx library.
• All DOM manipulations use globalDOM utilities.
• Assets (CSS, chart.js, xlsx) served from extension’s public folder as defined in manifest.
Architectural Patterns & Tech Stack
• Modular single-page script (no backend).
• Separation of concerns:
• Content script vs. feature modules vs. data vs. utils.
• Build tool: Vite + pnpm.
• Libraries: Chart.js for charting, SheetJS (xlsx) for export.
• Styling: plain CSS per feature.
Essential Elements
• Clear component names matching file names.