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.
   1. If you are on windows. You have to enable Windows Subsystem for Linux(WSL) and install Linux Distro to your machine to install NVM.
2. Run nvm install 12.18.2 to install Node 12.18.2.
3. Run nvm use 12.18.2 --default to set the Node version.

• Check your npm version(npm --version npm) and make sure the version is above v7 (if not upgrade with npm install -g npm)

1. Install Git.
2. Install VSCode.
3. Add the following extensions to VSCode.
   • NPM Intellisense
   • GitLens
   • ESLint
4. (Optional) Install React Dev Tools and Redux DevTools extensions to your preferred web browser.
5. Visit github.com/engaging-computing/MYR. In the top right corner, click "Fork" and follow the directions.
6. 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!

Connect with Backend

MYR also requires a running backend to have full features. 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 backend wiki

Note on the OAuth2 Key

It is very important that the developers have this key in both the front-end and back-end code, in the .env file. If it is only in one, then the developer will encounter an error every time the code is run, as well as trying to run actions that interact with the back-end.