ClassTrack

ClassTrack is an extension to populate your Google Calendar based on information from class syllabi.

Prerequisites

• Node.js and npm installed on your machine.
• A modern web browser (Chrome, Firefox, etc.) for testing the extension.

Running the Extension

Part 1: Loading the Extension to your Web Browser

1. Clone the repository to your local machine.
2. Navigate to the project directory.
3. Install the dependencies using npm install.
4. Build the project using npm run build.
5. Open Chrome and navigate to chrome://extensions/.
6. Enable "Developer mode" in the top right corner.
7. Click on "Load unpacked" and select the build directory of the cloned repository.
8. The extension should now be loaded and ready to use.
9. Open the extension by clicking on its icon in the Chrome toolbar.
10. Follow the on-screen instructions to set up the extension.
11. Use the extension to track your classes and manage your schedule.

Part 2: Running the Server

12. Download the backend file ParseCode.ipynb and run all the cells of the jupyter notebook.
13. Alternatively, if you have an SCU email, you can instead run the backend code on this Google Colab file.

Additional Information

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

The build folder is where the production-ready version of the extension will be located. You can load this folder into Chrome as an unpacked extension.

See the section about deployment for more information.

npm run watch

Runs the app in watch mode.
This command is useful for development and testing purposes. It will automatically rebuild the app whenever you make changes to the source code. This allows you to use the VS Code debugger to debug the extension in Chrome.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

External Documentation

• Chrome Extension Documentation
• React Documentation
• Google Calendar API Documentation
• Google Drive API Documentation

Scripts

In the scripts directory, you can find the following scripts:

• tsv_to_json.js: A script to convert TSV files to JSON format.

tsv_to_json.js

This script converts a TSV file to JSON format. It reads the TSV files from the folder json/tsv_files, parses it, and writes the output to respective JSON files in json/courses. Run the script with the command: node scripts/tsv_to_json.js.

CourseAvail Endpoints

The CourseAvail API endpoints are used to fetch course data and confirm course schedules. Below are the available endpoints:

1. Get Available Quarters

GET https://www.scu.edu/apps/ws/courseavail/autocomplete/quarters/
Returns a list of all available quarters.

GET https://www.scu.edu/apps/courseavail/export/?file=course.json Returns a JSON file containing all available quarters.

2. Search Courses by Quarter

POST https://www.scu.edu/apps/ws/courseavail/search/{quarter}/
Fetches all available courses for a specific quarter.

Parameters:

• q: The search text used to filter courses (e.g., "CSEN_174", "ECEN_50", etc.,).
• maxRes: The maximum number of results to return.
• subject: The search text used to filter courses by subject (e.g., "CSEN", "MATH", etc.).
• school: The search text used to filter courses by school (e.g., "AS", "BUS", "EGR", etc.).
• instr: The search text used to filter courses by instructor (e.g., "Smith", "Johnson", etc.).

3. Get Available Departments

GET https://www.scu.edu/apps/ws/courseavail/autocomplete/{quarter}/departments/ Returns a list of all available departments for a specific quarter.

4. Get Available Pathways

GET https://www.scu.edu/apps/ws/courseavail/autocomplete/{quarter}/pathways/ Returns a list of all available pathways for a specific quarter.

5. Get All SCU Courses

GET https://www.scu.edu/apps/courseavail/export/?file=course.json Returns a JSON file containing all SCU courses.

GET https://www.scu.edu/apps/courseavail/export/?file=course_section.json Returns a JSON file containing all SCU course sections with their quarters.