Installation Notes (Supplemental) - netcreateorg/netcreate-itest GitHub Wiki

NVM on Mac

The [official instructions] describe Macintosh installation. These instructions are based on installing the development environment from scratch on MacOS High Sierra.

  • open Terminal
  • mkdir .nvm; touch .bash_profile
  • paste from official nvm instructions (looks like curl -o- https://raw.githubusercontent.com/creationix/nvm/blah blah blah| bash) in terminal
  • close Terminal, reopen it
  • nvm install 9.5
  • nvm use 9.5 in netcreate directory

Dev Tools

If you're installing your development environment from scratch, here's what Dave is currently using:

EDITOR - Visual Studio Code

This is a very nice editor with a built-in terminal and excellent plugin support. It's a little slower than Sublime Text 3, our previous recommended editor, but Visual Studio Code is much more polished with a better user experience. It also has built-in git integration so you can see what you've changed compared to your copy of the NetCreate repo.

I also use the following plugins:

  • EditorConfig for VS Code - automatically sets VSC to use our recommended text file settings (line ending type, indent style, indent size), which are stored in the .editorconfig file
  • ESLint - eslint is a scanner that looks for errors in your code and checks for style. This plugin enforces our code style and points out obvious typos and bugs as you type. The project has an .eslintrc.json file in it that sets our code standards.

GUI for GIT - Sourcetree

Although the official GUI for GitHub is Github Desktop, I like Sourcetree better because it implements the vanilla approach to git that encourages understanding how it works. Github Desktop, by comparison, imposes its own workflow on top of the vanilla approach. You can interchangeably use Sourcetree and Github Desktop at the same time, along with the git command line.