How fu-capstone-su2025/front-end works
Project type and purpose
• This is a single-page, client-side React application (TypeScript) for an AI-powered academic advising platform.
• It serves multiple user roles (Student, Advisor, Staff, Manager, Admin), displaying dashboards, chat, data tables, charts, and AI features.
• It communicates via RESTful APIs (Axios) to a back-end (AISEA Back-End) and uses real-time hubs (SignalR) for chat/notifications.
File structure
Top-level files & folders:
• Dockerfile, nginx.conf, .github/workflows: deployment configs (Docker + DigitalOcean + CI/CD)
• public/, index.html: static assets and entry HTML
• src/
– api/: wrappers around Axios REST calls, organized by domain (Account, SchoolAPI, advisor, student, etc.)
– components/: reusable UI pieces, grouped by user role (admin, advisor, manager, staff, student) plus common controls
– pages/: route-level components (one per view) matching user roles
– hooks/: custom hooks encapsulating business logic, data fetching, state interactions, chat hubs
– router/: React Router definitions
– utils/, data/, interfaces/: helper functions, mock data, type definitions
– App.tsx, main.tsx: application bootstrap, provider setup (Zustand store, Router, Layout)
README for extra context
• Confirms React+TypeScript, REST API via Axios, Zustand for state, JWT auth, Docker+Nginx deployment, GitHub Actions CI.
• Mentions AI‐integration (Gemini AI, Google Agent Dev Kit) on the back end and real‐time features (SignalR).
• Lists user roles and high-level features (dashboards, GPA calculator, AI-chat, semester planning, data import).
Main components and their interactions
a. User Interface Layer (Browser)
– Role-based Pages (StudentDashboardPage, AdvisorPage, etc.)
– Shared Components (NavBar, ChatBox, DataTable, Charts, Forms)
– CSS Modules for styling
b. State & Business Logic Layer
– Zustand store (global.tsx)
– Custom Hooks: useAuths, useCRUDStudent, useNotificationHub, useChatApi, useSendAIMessenger, etc.
c. API Layer
– axiosCRUD wrapper + domain APIs (UserAPI/AuthAPI, AdvisorAPI, StudentAPI, SchoolAPI/*)
d. Real-time Services
– SignalR hubs (ChatHub, NotificationHub via useNotificationHub, useAdvisorChatHub)
e. External Services (Back-end)
– AISEA Back-End microservices (Auth, AcademicData, AI engines)
– Database (Postgres/Mongo/etc.)
– AI services (Gemini AI, Google Agent Dev Kit)
f. Deployment Infrastructure
– Docker container running Nginx serving static assets + reverse-proxy to APIs
– CI/CD (GitHub Actions) → DigitalOcean / Vercel
Architectural patterns & principles
• Feature-driven folder structure (group by role/domain)
• Separation of concerns: Presentation (components/pages) vs. Logic (hooks/store) vs. Data (api/)
• RESTful API client abstraction with centralized AxiosCRUD
• Real-time event handling via SignalR hubs
• JWT authentication with ProtectedRoute wrapper
• Containerized static serving + reverse proxy
Final checklist
[ ] All five user roles & their landing pages
[ ] Shared UI Component library
[ ] State store (Zustand) & Hooks layer
[ ] API client layer & domain APIs
[ ] SignalR real-time connections
[ ] External Back-end services & AI engines
[ ] Deployment (Docker + Nginx) and CI/CD pipeline