Jupiterp

Jupiterp is a website built to help students at the University of Maryland plan their schedules and make informed decisions about their course and section selections. Jupiterp provides a course planner that allows students to search for courses, see sections complete with professor reviews from PlanetTerp, and visualize their course schedule.

Jupiterp is split into two components: datagen and site. The datagen component includes web-scraping and API tools which are responsible for obtaining course information and reviews, and is built using Rust. The site component contains the front and backend of the actual site students will be able to visit and use, and is built using SvelteKit with TypeScript.

Jupiterp is not officially affiliated with the University of Maryland; it is primarily managed and maintained by @atcupps. Contact admin@jupiterp.com for any inquiries.

For more information on Jupiterp and on contributing to this project please see CONTRIBUTING.md. Otherwise, see the instructions below to learn how to work on this project.

Getting Started

Prerequisite Installations

Before working on Jupiterp, make sure your computer has the following installed and functional dependencies:

• Rust
• Cargo
• Node.js

Jupiterp also supports using Bun in addition to npm, but Bun on Windows OS is supported only experimentally. Instructions to install Bun are can be found here.

Datagen

To run datagen, navigate to the datagen folder. Using cargo, you can run two different binaries:

• Use cargo run --bin jupiterp_datagen <TERM> to run the datagen component. The <TERM> argument specifies which term (202401 for Spring 2024, 202408 for Fall 2024) to generate data for.
• Use cargo run --bin test -- <ARGS> to run tests using the testing CLI. Note the -- between test and the <ARGS>. Run cargo run --bin test -- --help to see available arguments, and see datagen/src/bin/tests.rs for more information.

Site

To test the site, navigate to the site folder. Use npm run dev (or bun run dev) to run the site locally, then use a browser to navigate to http://localhost:5173/.

Contributing

See CONTRIBUTING.md to view instructions on the collaborative development process for Jupiterp.