Tutor Project

UTDesign Project - An online tutoring scheduler application.

Running the Project (for CS 4485 professors)

Prerequisites: Install NodeJS on your computer if you don't already have it. Download it here. The LTS version will be sufficient. NPM will be automatically installed.

Running the application

1. Extract the file source_code.zip
2. Open the folder source_code
3. Open up a terminal in that folder.
4. Run the command npm run local. This will install all the required dependencies, build the application, and start the server. This may take a few moments depending on your internet connection speed.
5. Navigate to http://localhost:5000 in your preferred web browser.

Local development (for developers)

Prerequisites: Install NodeJS on your computer if you don't already have it. Download it here. The LTS version will be sufficient. NPM will be automatically installed.

Note: Technically, there are two npm projects in this repository. When both are running they can interact with each other and exchange data. On your local machine, the frontend application will run on localhost:3000 and the backend server will run on localhost:5000

Running the backend server

1. Clone the project if you haven't already by running git clone https://github.com/zsim314/Tutor_Project
2. Enter into the directory by running cd Tutor_Project
3. Run npm install
4. Make sure nodemon is installed by running npm install -g nodemon.
5. Run npm test. If you don't get any errors, then the backend is running.
6. Navigate to localhost:5000 in your favorite web browser.

Running the frontend application

1. Clone the project if you haven't already by running git clone https://github.com/zsim314/Tutor_Project
2. Enter into the directory by running cd Tutor_Project
3. Enter into the frontend project by running cd frontend
4. Run npm install
5. Run npm start
6. Run npm start. If you don't get any errors, then the frontend is running.
7. Navigate to localhost:3000 in your favorite web browser.

Building the project for production

1. Open a command line in the server project (path/to/Tutor_Project/)
2. Run npm run www. This script deletes the www/ folder, builds the frontend project, then copies the built project files into www/