VIAplanner/via-timetable

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<p align="center">
  <a href="https://docs.viaplanner.ca/" target="_blank">
    <img alt="VIAplanner" width="300" src="./VIA-Planner-Blue.png">
  </a>
</p>

<p align="center"> 
   <a href="https://app.netlify.com/sites/viatimetable/deploys">
    <img alt="Build Status" src="https://api.netlify.com/api/v1/badges/3b870967-d243-450c-8672-3add3187a16f/deploy-status">
  </a>
  <a href="https://github.com/VIAplanner/VIAplanner/blob/master/LICENSE">
    <img alt="License" src="https://img.shields.io/badge/license-GPL-green?style=flat">
  </a>
</p>


# VIAplanner

VIAplanner is a tool designed by students at the University of Toronto to help the community. We desire to enhance the course selection process.

## Introduction

The fundamental problem we are trying to solve :
1. The current process is to choose your courses and manually create a schedule without any conflicts. This can take days to perfect.

2. With the help of this tool, we are making this process faster and easier than before.

3. Furthermore, this will improve UofT's reputation since this tool will modernize a crucial part of a student's life.

# Documentation
[VIATimetable Documentation](https://docs.viaplanner.ca)

## Installation Using NPM

```sh
git clone https://github.com/VIAplanner/via-timetable.git
cd via-timetable
yarn
yarn serve
```

## Testing

Tests are found in `tests/`

```sh
yarn run test:unit
```