How nikhil-coder390/gdevaluationsystemfrontend works
Project type and purpose
• This is a single-page frontend application (React + TypeScript + Vite) for a “GD Evaluation System.”
• Purpose: Provide evaluators, administrators, and participants with real-time session management, scoring UI, analytics dashboards, and report generation.
File structure
Top-level:
• public/ – static assets (index.html, robots.txt)
• src/ – all application code
– main.tsx → application entrypoint, renders <App /> into index.html
– App.tsx + App.css → root layout, routing setup
– components/ → reusable UI pieces:
· auth/ (LoginForm, RegisterForm)
· layout/ (Navbar, Breadcrumb, PageContainer)
· ui/ (buttons, dialogs, tables, inputs, toasts, etc.)
– pages/ → route-level views (HomePage, DashboardPage, CreateSession, EvaluateSession, ExportReports, SessionDetails, SessionResults, Profile, LoginPage, RegisterPage, NotFound)
– context/ → React Context providers (AuthContext, GDContext)
– hooks/ → custom hooks (useMobile, useToast)
– integrations/ → Supabase client + types
– lib/ → utility functions
– types/ → shared TypeScript types
• config files: tsconfig.json, tailwind.config.ts, vite.config.ts, postcss.config.js, eslint.config.js
README insights
• Features: real-time evaluation, multi-parameter scoring, role-based UIs, session scheduling, analytics, PDF/Excel export
• Tech stack: React, TypeScript, Context API, Tailwind CSS, Axios (HTTP client), React Router, Vite, Jest/RTL
• Environment-based API URL and Supabase integration
a. Components:
• Browser (User Agent)
• Frontend SPA
– Routing layer (React Router)
– UI Layer (Tailwind + custom UI components)
– State layer (AuthContext, GDContext + custom hooks)
– Integrations (Supabase client, Axios to backend API)
• Backend API (external service)
• Supabase (Auth, DB tables)
• Database (PostgreSQL, via Supabase)
• Third-party services: PDF/Excel export library, analytics chart lib
b. Interactions:
1. User navigates pages via React Router → loads corresponding page component
2. Page component uses context/hooks → fetches data from Backend API / Supabase
3. AuthContext manages JWT tokens → attaches to API requests
4. GDContext manages session state in real time
5. UI components render data, send user input back to contexts/hooks → API calls
6. Responses update context → UI updates
c. Architectural patterns & principles:
• Component-based architecture (atomic UI library + composite page components)
• Separation of concerns: UI, state, data-fetching are decoupled via Context + hooks
• Unidirectional data flow: context/providers → page → UI → actions → API → context
• Integration abstraction: “integrations/” folder isolates Supabase client
• Configuration-driven (env vars for API_URL, build configs via Vite)
d. Key technologies:
• React + TypeScript for UI & type safety
• Vite as build tool / dev server
• Tailwind CSS + PostCSS for styling
• React Router for client-side routing
• Context API for global state
• Axios or fetch for HTTP calls
• Supabase SDK for auth & realtime DB
• Jest + React Testing Library for unit/integration tests
Essential details to capture
• Entry point: index.html → main.tsx → App.tsx → Router
• UI library folder vs. business-logic pages
• Context providers wrapping the App
• Supabase client initialization and usage in contexts/hooks
• API URL injection from .env
• Tailwind/Vite build pipeline (config files)