The purpose of this project is to create an application that connects UMO students with tutors, and to facilitate the scheduling of tutoring sessions and assignments
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Editing and running tutor-app requires
NodeJS: https://nodejs.org/en/download/
React: https://reactjs.org/
and a code editor of your choice. The documents in the main folder can be opened using Microsoft Word and Excel, or any program that can import .docx and .xlsx files
mobx: Navigate to the repository, and run 'npm install mobx --save' Then run 'npm install mobx-react --save'
React boot-strap: navigate to the repository, and run 'npm install react-bootstrap bootstrap'
react-select: navigate to the repository, and run 'npm i --save react-select'
user-event: navigate to the repository, and run 'npm instal --save-dev @testing-library/user-event'
##Running the App The website can be run by opening your system's command line and entering
'cd (directory of tutor-app folder)'
'npm start'
This will start the react server and open the website in your default web browser
Alternatively, Windows users can quickly start the website by running the "start.bat" file in the tutor-app folder
The website can be tested by opening your system's command line, and entering
'cd (directory of tutor-app folder)'
'npm run test'
This will start the Jest Testing
We use NVM (https://github.com/nvm-sh/nvm) for versioning. For the versions available, see https://github.com/hannahyelle/Tutor-Software-Engineering/tags
- Calvin Mueller, Chase Pisone, Hannah Yelle, Hunter McDaniels-Rossiter, Klei Bendo