Setting up a Development Environment

Mandatory Installs

• Node - JavaScript Runtime
• Create React App - This is a neat package for executing the react app we are building for MYR. It will contain the parsers, servers, scripts to run the app
• Git - You should know what this is and what it does, if you have questions ask away but Git is extremely well supported
• Yarn - Yarn grabs Node packages and run scripts

Suggested Installs

• VSCode - modern day text editor with lots of nice features for writing code

  Optional Packages

  • NPM Intellisense - helps you import the right packages
  • GitLens - helps you use Git inline with the code
  • ESLint - makes sure your code conforms to standards
  • Debugger for Chrome - allows you to use VSCode to debug JavaScript

Running the App

1. Open a terminal and navigate to where you want to save MYR and run git clone https://github.com/isenseDev/MYR.git.
2. Once the repo is downloaded you need to run Yarn to download the packages just type yarn install into the terminal and hit enter.
3. Almost there, now just type yarn start into the terminal and hit enter and you will see the app start to compile. Normally the browser will open but if not you can typically find the page at localhost:3000.

Notes

Some features such as snapshots and courses require 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.