How sun92122/ntnux works
Project type and purpose
• This is a full-stack web application with two distinct parts:
• A backend “data pipeline” in Python that crawls, analyzes, processes, and stores JSON datasets.
• A Nuxt.js (Vue) frontend that consumes those JSON files as static assets and renders a web UI (schedule/course viewer).
• The empty README suggests no additional architectural docs; we infer from the file tree:
• Backend directory contains crawler, hook modules, original_data, and processing tools.
• Frontend directory follows a Nuxt project structure, with pages, components, static assets under public/data, and configuration files.
File structure
• Top-level
• backend/ – Python scripts for ETL
– crawl/browser.py (web crawler entry)
– hook/analysis.py & save.py (data transformation & persistence)
– tool/ (utilities: minimize, parse, proxy, strip)
– original_data/ (raw JSON input + formatted JSON)
– main.py (orchestrator)
– requirements.txt
• frontend/ – Nuxt3 application
– pages/ (Vue pages)
– components/ (reusable Vue components: FloatingSchedule.vue, courseCell.vue)
– public/data/ (static JSON served to client)
– nuxt.config.ts, package.json, tsconfig.json
– server/ (TypeScript config for server-side API if any)
• Patterns
• Backend implements an ETL pipeline (Extract via crawl, Transform via hook & tool, Load into JSON files).
• Frontend is a static-first SPA/SSR with static JSON assets served under /data.
Key insights from README
• README.md is empty; rely fully on inferred architecture.
Elements
• Clear labels for each component (e.g., “crawl/browser.py”, “Nuxt Server”)
• External world (gray)
Final recommendations
• Be very detailed: break the backend into its scripts and highlight the ETL stages.
• How static data flows into the frontend build or runtime.