This is the repo for the Tutor Queue used by the CS Tutor Center at the University of Arizona. It is maintained by the tutor center coordinators. This is based heavily off this project created by Connor Brett, Aramis Sennyey, and Hung Le Ba.
To be able to run this project, a .env file needs to be added to the server directory with credentials. The following is the environment variables the project expects:
DATABASE_URL = Connection URL to the MongoDB database.
JWT_KEY = A key for your JWT encryption (can be anything).
GMAIL_EMAIL = The email for reset password links to be sent from.
GMAIL_PASSWORD = The password to that email.
SERVER_URL = The url where the site will be hosted (used for the url in reset password email).
The recommended method to running the project is through Docker. Be sure to install docker on your system before continuing.
To get the most current image, be sure to run:
sudo docker pull tutorcoords/tc:latest
Once the updated image is pulled and all other docker containers being ran on port 3000 are killed, run:
sudo docker run -p 3000:3000 -d --env-file <PATH TO ENV FILE> tutorcoords/tc:latest
This will host the project on port 3000.
NOTE: The docker hub image (where you are getting the projects docker image from) is automatically updated through github actions whenever something is pushed to the main branch. This ensures it is always up to date. The docker image can also be built manually (docker build -t <DESIRED IMAGE NAME> . within the main directory) and ran with the same command (the tutorcoords/tc:latest would need to be replaced with whatever you named your local image).