Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.55 KB

README.md

File metadata and controls

25 lines (17 loc) · 1.55 KB

drawing

PlanNUS

What is PlanNUS?

PlanNUS is a web application catered towards students of the National University of Singapore (NUS). As the name suggests, it is a tool for students to plan their academic timetables by automatically generating the most ideal timetables for them. PlanNUS is designed to be a companion tool for NUSMods and aims to aims to ease the burden of NUS students in the process of timetable planning, which can get quite overwhelming at times.

Where can I learn more about the project?

Please refer to our project report for in-depth developer documentation as well as discussion on our design decisions.

How does it work?

All that a student needs to do is select a semester, the modules they intend to take for that semester, and their priorities ranked from most to least important. PlanNUS will process all of this information using its algorithm and output a list of personally tailored timetables. Students can then save the timetables they like, and even share these timetables with friends should they wish to coordinate their classes together.

How to run PlanNUS

Run on Firebase Hosting

Navigate your browser to the following URL: https://plannus-cfd18.web.app/

Run locally

  1. Clone from the repository.
  2. Navigate to the local repository in a terminal window.
  3. Change directory to the view folder: cd view
  4. Install dependencies with: npm install
  5. Start running the application with: npm start