How cis3296s25/01-smartschedule works
Main components
• Frontend: The React application located in the "src" directory along with the public assets and configuration files (e.g., vite.config.js, package.json). Key components here include the main React components (CourseSearch, GeneratedSchedules, SaveLoadControls, ScheduleRestrictions, SelectedCourses, SemesterSelector) that are part of the user interface.
• Backend: The Python server in the "backend" directory. The main entry point is backend/main.py, with additional utility modules (backend/utils/fetch.py) that assist in data fetching and possibly other backend tasks.
• API Endpoints: Clearly described in the README, including endpoints to get subjects and courses as well as the root endpoint. Also note the Swagger UI available under /docs for interactive API testing.
And map the relationships/interactions
• That the backend, powered by uvicorn, handles the HTTP requests, returns JSON responses, and exposes endpoints like GET /, GET /api/subjects, GET /api/subject/courses, and GET /api/all-courses.
• External tools like Swagger UI as an optional component to represent developer interaction with the API.
And highlight architectural patterns/design principles
• Separation of Concerns: Notice the clear division between frontend and backend. Frontend components handle UI and presentation, while the backend is solely dedicated to business logic and API servicing.
• Modular Architecture: The backend is split into main application logic (main.py) and utility functions (utils/fetch.py), while the frontend is organized into a component-based structure typical for React applications.
Detailing relevant technologies and libraries
• Frontend: React, Vite (for bundling and HMR), ESLint (for code standards), and possibly Babel or SWC (as indicated by the available plugins for fast refresh).
• Backend: Python 3.9+, uvicorn (for running an ASGI server), and internal utility modules for handling specific backend tasks.
• Configurations files like eslint.config.js and vite.config.js that configure the development environment.