How anupam-anupam/uoft-webring works
Project Type and Purpose
• This is a static front-end web application (“webring”) that runs entirely in the browser.
• Purpose: display a community list of personal websites for UofT students. Data comes from a JS file (sites.js), visuals from index.html and images/.
• No backend service, no database—just static hosting (e.g., GitHub Pages or any web server serving files).
File Structure
• Top level:
• README.md – project description & setup
• index.html – entry point / HTML template
• sites.js – JavaScript module containing the list of webring members
• images/ – folder of static assets (logos, avatars, etc.)
• No src/, backend/, or server code—this is a client-only app.
• No build scripts, no package.json: you just open index.html.
Key README Insights
• Instructions focus on forking the repo, editing sites.js, and opening index.html.
• Emphasis on Git/GitHub for contributions.
• No mention of frameworks or bundlers—pure HTML/vanilla JS.
Main Architectural Components
a. Browser (Client)
• Loads index.html.
• Executes sites.js to render the webring list dynamically.
• Fetches images from images/.
b. Static File Host (Web Server/CDN/GitHub Pages)
• Serves index.html, sites.js, and images/ to the browser.
c. Version Control (GitHub)
• Repository storing all files.
• Contributors fork, edit sites.js, and submit pull requests.
Relationships & Data Flow
• User’s Browser → (HTTP GET) → Static Host → index.html + sites.js + images → Browser renders UI.
• Developer Workstation ↔ GitHub Repo (clone, push PRs) → Static Host deploys from main branch.
• In-Browser JavaScript reads the data array in sites.js, then manipulates the DOM.
Architectural Patterns & Design Principles
• Separation of Concerns: HTML structure in index.html, data in sites.js, assets in images/.
• Single Page Application (SPA)-light: no page reloads; dynamic content insertion via vanilla JS.
• Static Hosting: zero-server backend, easy CI/CD with GitHub Pages.
Technologies & Libraries
• Vanilla HTML5 and JavaScript (no frameworks).
• Git & GitHub for version control and collaboration.
• (Optional) Any static file host or CDN for deployment.