Skip to content

A minimalistic, simple and MODERN Course Catalog Planner and Search for Vanderbilt Students.

Notifications You must be signed in to change notification settings

SySyAli/vanderbilt_catalog-frontend

Repository files navigation

Vanderbilt Course Catalog Planner

A minimalistic, simple and MODERN Course Catalog Planner and Search for Vanderbilt Students.

Preview

Animated Preview

Installation

To install and run this project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/SySyAli/vanderbilt_catalog-frontend.git
  2. Install the dependencies:

    cd your-repo
    npm install
  3. Start the server:

    npm run dev

    The server will start running on http://localhost:5173.

Detailed Explanation

This web app has two primary features: the COURSE PLANNER and SEARCH features. The course planner is meant to help students plan their semester based upon the Vanderbilt Course Catalog. To explain this feature, one can simply add the semesters they are interested in a planning for. After, each semester can contain many possibilities and each possibility can contain multiple course selections. This can all be exported to excel. There is also the search feature, which uses algolia to search through the data.

This is how an example data object would look.

FullView: [ Semester[] ]
Semester: { id, num, Possibility[] }
Possibility: { id, Courses[] }

type Course {
  _id: String,
  code: String,
  name: String,
  department: String,
  departmentAbbreviation: String,
  hours: String,
  description: String
}

Acknowledgements and References

About

A minimalistic, simple and MODERN Course Catalog Planner and Search for Vanderbilt Students.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published