https://github.com/atsixian/mcgill-course-map

Discover McGill: a graph of interrelated courses at McGill
https://github.com/atsixian/mcgill-course-map

course-dependency courses-stemming graph mcgill mcgill-course

Last synced: 8 months ago
JSON representation

Discover McGill: a graph of interrelated courses at McGill

• Host: GitHub
• URL: https://github.com/atsixian/mcgill-course-map
• Owner: atsixian
• License: gpl-3.0
• Created: 2019-07-13T04:29:14.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T03:55:31.000Z (almost 3 years ago)
• Last Synced: 2023-06-27T14:56:50.985Z (over 2 years ago)
• Topics: course-dependency, courses-stemming, graph, mcgill, mcgill-course
• Language: Python
• Homepage: https://mcgill-course-map.herokuapp.com/
• Size: 2.55 MB
• Stars: 30
• Watchers: 1
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# McGill Course Map

## Find your path easily

### Features

People's interests vary, so do their degree paths.

McGill's website only shows what are prerequisites for a course but not where you can go after it. For those who are unsure about their future paths like me, possibilities matter. McGill Course Map comes to your aid.

It shows relationships between courses, so you can see all courses stemming from the one you are currently taking with information about term.

### Guide

**Path mode** 

![Path mode](demo_images/path-mode.PNG)

shows all courses stemming from the one you search in the "Course Name" input box.

![](demo_images/info-panel.PNG)

**Course info panel** provides the full name, credits, and terms offered of the one you clicked in the graph. You can go to the original page by clicking its name.

**Filters** filter out courses from certain subjects.

**Layout** changes the layout of nodes in the graph.

Examples:

![](demo_images/filter.PNG)

![](demo_images/layout.PNG)

**Overview mode**

![](demo_images/overview-mode.PNG)

It shows all courses from the subject you search. You can also see courses from other subjects that are relevant. For example, math 223 is a prerequisite for a lot of comp courses.

![](demo_images/mini-map.PNG)

**Mini-map** shows which courses you can take JUST after the one you clicked. It's a breadth-first-search with depth limit 1. You can also go to the original page by clicking its name.

 ![](demo_images/navbar.PNG)

Author, link to the GitHub page, link to the GitHub issues page, and the detailed guide can be found in the navigation bar.

### How to run this app locally

1. `git clone https://github.com/Deerhound579/mcgill-course-map.git`

2. Create a virtual environment with Python 3.7.3 or higher. I recommend following this [Pyenv tutorial](https://realpython.com/intro-to-pyenv/#using-the-pyenv-installer) to manage your Python versions and set up the env.

3. `pip install -r requirements.txt` installs all dependencies

4. `python app.py`

### How to run the spider

If you want to run the spider, you need to install dev dependencies by 

`pip install -r dev-requirements.txt`

In the project root directory, run `scrapy crawl courses`. All output data will be stored in `course_data` folder.

### License

Copyright © Sixian Li. 

McGill is a University in Montreal and has no affiliation with this software.

This software is under GNU General Public License v3.0. More info can be found in the [LICENSE]() file.