adamgleizer / courseography

Courseography is a tool created by David Liu and Ian Stewart-Binks to guide students through their undergraduate careers.

Courseography

About

Here at the University of Toronto, we have hundreds of courses to choose from, and it can be hard to navigate prerequisite chains, program requirements, and term-by-term offerings all at once. That's where Courseography comes in: by presenting course and scheduling information in a set of graphical interactive tools, we make it easier to choose the right courses for your academic career. Whether it's making sure you'll satisfy all the prerequities for that 4th year course you really want to take, or fitting together fragments of your schedule for next term, we hope Courseography makes your life easier!

Powered by Haskell, Courseography was started in late 2013 by David Liu. However, it wasn't until he recruited Ian Stewart-Binks to the project that things really got rolling. Though the past two years have really seen our tools take off within the CS student body, there's still a long way for us to go. Our current projects include moving the front-end of the application over to React, unifying the graph viewing and drawing tools, and improved exporting and report generation.

Getting Involved

See CONTRIBUTING.md.

Say hello on our [Slack channel][slackin]! ![Slack][slackin-badge]

Quickstart and Setup

If this is your first time running Courseography, please click here. The following is intended to be a quickstart guide and not a proper tutorial.

Download Courseography

1. Run $ git clone https://github.com/Courseography/courseography.git to create a local copy of the Courseography.

Software Dependencies

First install both of the following.

1. Stack
2. ImageMagick

On Windows, install Chocolatey.

On Mac, install Homebrew.

Then, open a terminal (in Windows, run as Administrator) and run

$ scripts/setup_<your os>

Note: this is a script intended for beginners; you may wish to read through the script and run modified commands to suit your own needs.

Other Files

Run these two steps manually.

1. Copy app/DevelopmentConfig.hs to app/Config.hs with $ cp app/DevelopmentConfig.hs app/Config.hs
2. Create the db folder with $ mkdir db

Installing

1. Install the latest GHC compiler with $ stack setup
2. Compile Courseography with $ stack build

Parsing and Generation

1. Create database file for an parse prerequisite graph $ stack exec courseography graphs
2. Parse course information $ stack exec courseography database
3. Generate the CSS $ stack exec courseography css

Running

1. Run $ stack exec courseography to start the server
2. Navigate to http://localhost:8000/graph in your browser

Contributors

This project would not exist without the contributions of many students in the Department of Computer Science. In alphabetical order, our contributors are:

Alex Baluta, Alexander Biggs, Kelly Bell, Christina Chen, Eugene Cheung, Kael Deverell, Spencer Elliott, Lana El Sanyoura, Ryan Fan, Ailsa Fang, Christian Garcia, Ross Gatih, Sidharth Gupta, Parker Hutcheson, Philip Kukulak, Ryan Lee, Tamara Lipowski, Lydia Liu, Nathan Liu, Jahnavi Matholia, Hermish Mehta, Mia Meng, Christine Murad, Justin Park, Sam Shaftoe, Ian Stewart-Binks, Betty Wang, Fullchee Zhang, Minfan Zhang

Privacy Policy and Licensing

Click here to learn about our Privacy Policy.

Click here to learn about our licensing.