Setting up a Development Environment

Install MYR

1. Install Node.js (a JavaScript Runtime) via NVM. Follow the direction from the NVM website to install it on your OS.
2. Run nvm install 12.18.2 to install Node 10.18.2.
3. Run nvm use 12.18.2 --default to set the Node version.
4. Install Git.
5. Install VSCode.
6. Add the following extensions to VSCode.

• NPM Intellisense
• GitLens
• ESLint

1. Install React Dev Tools in Google Chrome.
2. Visit github.com/engaging-computing/MYR. In the top right corner, click "Fork" and follow the directions.
3. On your computer, run the following commands. (This requires git to be installed.)

git clone https://github.com/[your-username]/MYR.git  
cd MYR  
git remote add upstream https://github.com/engaging-computing/MYR.git

1. Make a copy of .env.example and rename it to .env.
2. Update .env to include your OAuth2 key.
3. Run npm install to download required packages.
4. Run npm start to start the server.
5. Navigate to localhost:3000 in your browser to see your local server!

Notes

MYR also requires a running backend. The backend must first be installed and then running at the same time as the MYR server is running. The directions for installing the MYR backend are located in the wiki for that project.