mapillary-js/CONTRIBUTING.md
Oscar Lorentzon 53878c56f0 Use tsconfig compiler options in node server.
Update running instructions.
Use npm script to run tests on git push.
2016-07-12 17:57:16 -04:00

1.2 KiB

Preparing your Development Environment

Linux

Install GNU Make and git:

sudo apt-get update &&
sudo apt-get install build-essential git

Install node.js 5.x and npm according to the node.js package manager installation instructions.

Clone a copy of the repo:

git clone https://github.com/mapillary/mapillary-js.git

Change to the mapillary-js directory and install node module dependencies:

cd mapillary-js &&
npm install

OSX

Install the Command Line Tools for Xcode:

xcode-select --install

Install Homebrew according to the instructions.

Install node.js:

brew install node

Clone a copy of the repo:

git clone https://github.com/mapillary/mapillary-js.git

Change to the mapillary-js directory and install node module dependencies:

cd mapillary-js &&
npm install

Serving the Debug Page

npm start

Open the debug page at http://localhost:3000.

Running Tests

npm run test