How harikrishnan669/ritcompass-fe works
Project type and purpose
• This is a front-end single-page application (SPA) for “RIT Compass,” built with React and TypeScript.
• It provides searchable, structured college information, an interactive chatbot, step-by-step guides, and auto-generated letters.
• It consumes a separate backend API (hosted via VITE_BASE_URL) that performs NLP and data retrieval.
File structure
• Top-level files include configuration (package.json, tsconfig, tailwind.config.js, vite.config.ts), public assets (index.html, /public), and source code under /src.
• /src/pages groups route targets (home, info, letter, login, signup, more-features).
• /src/components houses reusable UI pieces (404Page, AIMessage, Timeline, LetterLoader, plus a magicUI library and ShadCN-based UI components).
• /src/lib holds shared code (axiosInterceptor for HTTP requests, utils).
• /src/data defines data models and static data.
• Routing is managed by React Router in main.tsx.
README for additional insights
• Tech stack: React.js, TypeScript, React Router, Tailwind CSS, ShadCN UI.
• Emphasis on NLP-driven search queries and a RESTful backend.
• Deployment via Vercel (vercel.json).