How timothyphan2/cs157a-coursebrief works
Project type and purpose
• CourseBrief is a full-stack web application for searching and discovering CS and CMPE courses at SJSU.
• Components:
• A React-based frontend (Vite).
• A Spring Boot REST API backend.
• A MySQL relational database.
• A Spring Shell–based admin CLI for course/tag management.
File structure
• Top level:
• backend/ – Maven project with src/main/java, resources, tests.
• frontend/CourseBrief/ – React (Vite) project.
• SQL scripts (createdb.sql, insertStatements.sql).
• backend structure:
• config/ – security and password configuration.
• controller/ – REST controllers for course, search, user.
• service/ – business logic services.
• repository/ – Spring Data JPA interfaces.
• model/ – JPA entities and embedded IDs.
• CourseBriefAdmin/ – separate CLI app using Spring Shell commands.
• frontend structure:
• src/api/axios.jsx – HTTP client.
• src/components/ – React pages and UI elements.
• src/userAuth/ – authentication context.
README for additional insights
• Confirms tech stack: React, Spring Boot, MySQL, Spring Shell.
• Describes startup steps: database scripts, running frontend, running backend, then inserting data, plus admin CLI.
Essential details
• Internal layers of the backend:
• Controllers (entry points)
• Services (business logic)
• Repositories (data access)
• Entities (database tables)
• User authentication context in the React app and the Spring Security layer in the backend config.
• Both runtime startup sequence (DB scripts → backend app → frontend server) and request-response flows.