How knightempire/aagneya-frontend works
Project type and purpose
• This is a static, front-end web application (deployed on GitHub Pages) built in HTML/CSS/JavaScript with Bootstrap and Tailwind CSS.
• Purpose: Support a sports-club platform where staff and members register, view/manage sports events, log achievements, track intracampus points, and access role-based dashboards (Admin, Community Members, Intramural).
File structure
• Top-level directories:
• “homepage/” – public site pages (home, about, events, team, etc.)
• “login/” – authentication screens (login.html, forgot/reset password, add profile/QA)
• “Admin Dashboard/”, “User Dashboard/”, “intramem Dashboard/” – role-specific UIs, each with its own HTML, CSS, JS, images.
• “index/” – marketing/front landing pages (with SCSS/Bootstrap source files)
• No server-side code in repo → purely static front-end.
• package.json suggests build toolchain (likely for SCSS), but no runtime backend here.
Key insights from the README
• Features describe user auth, event management, registration, achievements, dashboards, point-tracking.
• Technologies: HTML/CSS/JS, Bootstrap, Tailwind.
• Live deployment on GitHub Pages.
Main components
a. Front-End Client
• Browser running single-page and multi-page static assets:
• Public site (“homepage/”, “index/”)
• Authentication module (“login/”)
• Role dashboards (“Admin Dashboard/”, “User Dashboard/”, “intramem Dashboard/”)
b. Static Hosting Layer
• GitHub Pages (or any static file server / CDN) serving the compiled assets and SCSS/JS.
c. Back-End API (external or future extension)
• RESTful microservice endpoints for:
• Authentication (login, register, reset)
• Events (create, list, register)
• Achievements (CRUD, list)
• Intracampus points (fetch, update)
d. Data Storage
• User database (users, roles, credentials)
• Events database
• Achievements database
• Points ledger
e. Optional External Services
• Email/SMS service for password resets
• Analytics (e.g., Google Analytics)
• CDN for static assets
Relationships and interactions
• Browser → (HTTP GET) → Static Hosting Layer → serves HTML/CSS/JS
• Browser UI → (REST API calls) → Back-End API → (CRUD operations) → Data Storage
• Authentication flows: login/register pages call Auth API → User DB
• Dashboard pages call Events/Achievements/Points APIs
• External services invoked by Back-End API (e.g., email, analytics)
Architectural patterns & design principles
• Front-End vs. Back-End separation (static vs. dynamic layers)
• RESTful API microservices for each domain (Auth, Events, Achievements, Points)
• Role-based UI modules (Admin, Community, Intramural)
• Static asset pipeline (SCSS → CSS, JS modules)