How szeedneigh/learn-vanguard works
Project type and purpose
• From the file tree and README, Learn Vanguard is a single-page React application (built with Vite and Tailwind) that serves as a “Student Resource Hub.” There is no backend code in this repo—data and authentication are provided by external services (Firebase Auth, a REST API, and a WebSocket server).
File structure
• Top-level:
• public/ – static assets
• src/ – application code
• ├── app/ – page layouts and route wrappers (auth, dashboard, landing, 404, etc.)
• ├── components/ – reusable UI pieces, organized by domain (calendar, modal, ui primitives)
• ├── config/ – environment, Firebase, auth config
• ├── context/ – React Context providers (AuthContext, PermissionContext)
• ├── hooks/ – custom React hooks (API queries, toast, WebSocket, calendar state)
• ├── lib/ – low-level API clients, helpers, constants, navigation, react-query client
• ├── services/ – higher-level data-access services that wrap lib/api calls
• ├── utils/ – pure helper functions
• └── main.jsx, App.jsx – entry point and root component
• Ancillary config: vite.config.js, postcss.config.js, tailwind.config.js, vercel.json
README for additional insights
• The system uses:
• React + Vite + Tailwind + shadcn/ui for the frontend
• Firebase for authentication
• A custom REST API (announcement, event, resource, task, user, etc.)
• A WebSocket endpoint for real-time updates
• React Query (via lib/queryClient.js) for data fetching and caching
• Deployed on Vercel