For team members, refer to Information.md and Developing.md as the main guides.
git clone https://github.com/hueyjj/skadoosh
cd skadoosh
npm install
Then
npm run dev
or
npm run serve
Access the application at https://localhost:3000
Skadoosh is meant to be used in conjunction with MangoMountain, a django server. Please follow the instructions there to setup the server.
Skadoosh is a web application built on top of the UCSC's class searching API with support for tracking major and GE requirements, scheduling classes, login system, class and professor rating system with user reviews.
Skadoosh's foremost purpose is to help the user build their schedule faster and view it visually better than the current way in UCSC's portal.
The school's class search API at https://pisa.ucsc.edu/class_search/ has a few problems. First, it does not allow the user to compare their schedule or build their schedule, which can waste the user's time if they do not plan carefully. Second, it loses the previous format data when a user attempts to return to the search form, either through the web browser's back functionality or a return to the original url (https://pisa.ucsc.edu/class_search/).
The user interface in MyUCSC portal that has a schedule builder is unintuitive, buggy, and something from the early 2000s. The portal overall has an incredibly high delay (in seconds) when navigating the site, submitting data, or using any basic functionality really.
Documentation can be found locally when the repo is cloned. The index.html can be found at Skadoosh/docs/index.html. Please use a webbrowser to view the html contents.