How oliad1/doro works
Project type and purpose
• This is a full-stack grade-tracking application (“Doro”) designed to scrape and aggregate grade components for 1700+ Waterloo courses and expose them through a web interface and API.
• The frontend is a Next.js/TypeScript web app with client-side state (Zustand) and schema validation (Zod).
• The backend is a Node.js service (running under bun/PM2) exposing REST endpoints, interacting with a Postgres database (Supabase), and AWS S3 for storage.
• A separate Python scraping service fetches course metadata and persists it to the database.
File structure
• Top level:
• frontend/ – Next.js app
• backend/ – Node.js API server
• docker-compose.yml – orchestrates containers
• frontend/src/app contains route handlers (Next.js App Router); src/APIClients wraps calls to backend endpoints; components/ houses UI.
• backend/server.ts boots the Express-style HTTP server, controllers/ define endpoints, services/ implement business logic, repositories/ handle data access, models/ define ORM schemas, middlewares/ handle auth.
• utils/s3/client.ts configures AWS S3.
• .env.sample files in both frontend and backend suggest separate environment configurations.
• README mentions deployment on AWS EC2 with NGINX reverse proxy, PM2 process manager.
README for additional insights
• Architecture summary: Frontend (Next.js, TypeScript, Zustand, Zod), Backend (Node.js on AWS EC2, Nginx, PM2), DB (Supabase/Postgres), Scraping (Python, BeautifulSoup, Pydantic).