- You must have NodeJS & NPM installed
- You must have enough disk space for the project (~1GB from react libs)
- You must have a mongodb server, either local or hosted works. You can get one for free from here.
- You must have an image CDN to host the tutor images. We use Cloudinary and the project may not work with other CDNs.
-
Download the latest version of the repo and enter the directory
-
Run the setup.sh script (works fine bash or batch, powershell soon) or run the following:
git clone [email protected]:PSUCoders/tutoring-hub.git && cd tutoring-hub
cd front-end && npm install
cd ../back-end && npm install
git clone [email protected]:PSUCoders/tutoring-hub.git | cd tutoring-hub/
cd front-end/ | npm install
cd ../back-end/ | npm install
- Start the project
This project uses a RESTful NodeJS backend with a ReactJS frontend. To run the project, you must run one instance of the backend and another instance of the frontend. (In other words, 2 terminals)
# From the root dir
cd backend && npm start# From the root dir, in another terminal
cd frontend && npm start