FAU Course-Checker

This application will constantly check for an opening in a course you're waiting to join then text or email you about it!

Setting Up

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Node has to be installed first before continuing.

Installing

Run the command below in the main directory.

npm install

Config

The following variables need be changed in the config file for the application to work. See more info on setup here.

"fromEmailService": "<FROM_EMAIL_SERVICE>",
"fromEmail": "<FROM_EMAIL>",
"password": "<FROM_EMAIL_PASSWORD>",
"toEmail": "<TO_EMAIL>"

The following lines need be changed in the courses file for the application to search for the correct classes. The course subject, number, and CRN need to be provided.

courses.push(new Course('ARH', 2000, 10014));
courses.push(new Course('ARH', 2000, 13866));
courses.push(new Course('ENC', 1101, 10069));
courses.push(new Course('STA', 4821, 12336));

For more information on how to set the application to text you when there's an opening, see here.

Running Locally

Run the command below in the main directory.

node index