Node & npm Setup

Node & npm Setup

The VisualGit project uses both Node and npm for the development of this desktop application. Node is a JavaScript run-time environment that executes JavaScript code outside of a browser while npm is package manager that simplifies the installation of Node packages.

Contents

• Installing node and npm
  • Mac
  • Windows
  • Linux
    • Ubuntu or Debian
    • Fedora
• Verify your Installation
  • Node
  • npm
• Node and npm in the Project

---

Installing Node and npm

Mac

1. Install homebrew
2. Open terminal and enter brew update - this updates homebrew with the latest version of Node
3. Enter brew install node

If you do not wish to install homebrew, you can download and install the latest version of Node.js from here. Must be v6.2.1 or later

Windows

1. Download and install the latest version of Node.js from here. Must be v6.2.1 or later
2. Download and install python 2
3. Set the environment variable PYTHON to point to the python executable

Linux

Ubuntu or Debian

Run sudo apt-get install npm in terminal

Fedora

Run sudo yum install npm in terminal

Verify your Installations

Node

Verify installation of node by entering node -v - this prints the version of node you have

npm

Verify installation of npm by entering npm -v - this prints the version of npm you have

Node and npm in the Project

Before running the project run npm install in the project directory to install the dependencies of the project. If you run into issues please visit the Troubleshooting page of this wiki.

Otherwise you should be able to run the project by entering npm start. This runs npm-run-all -p createjs electron:serve which is given in the package.json of the project.

For full details on how to run the project visit "Running the Project"