WebAttendant is a simple web tool for generating a schedule for courses at the University of Guelph. It was created during the Fall 2022 semester of CIS*3760 by a team of seven students.

WebAttendant is temporarily being hosted at https://3.18.98.134

There are two main components to the app: the Flask backend and the React frontend.

This will create a localhosted flask server

make run

Run the following command inside of the project root.

npm start

If your distribution doesn't ship with make you will need to install it using sudo apt install make.

The following command will install all of the required packages needed to run the app.

make install

In order to run the app in a production environment, you will need to build and run the docker images.

First, connect to the machine you want to deploy the app on using ssh. Clone the project repository and navigate into it.

If you don't have make installed, you must install it using sudo apt install make.

Run the following command to install docker and docker-compose:

sudo apt install docker.io docker-compose

Run this command to build the docker images (you may need to run this as root):

make docker-build

Finally, you can run the app using (you may also need to run this as root):

docker-compose up -d

The app should now be running in the background as two docker containers on your machine (cis3760-react and cis3760-api).

The API can be tested using:

make test-api