Node.js - API Server

Development environment setup

This is what do you need to run this project locally:

1. Install and setup a Docker environment (Engine + Compose) following these instructions

2. Install Node.js

Suggestion: install nvm (Node Version Manager) and then install node v0.12.7 by running

$ nvm install 0.12.7

3. If everything is installed correctly you can run this to start docker images from this project root

$ docker-compose up

It'll create and start containers for each item on docker-compose file

Add the flag -d to this command to run it in backgroud. To stop the services run

$ docker-compose stop

Running this project

1. Install all dependencies by running the following command on project root

$ npm install

1. Run this to start server

$ npm run start

Test

$ npm install
$ npm test

caveat

Travis build will execute $ npm run travis, so environment variables can be used exclusively for CI, depending on the needs

npm shrinkwrap

To shrinkwrap an existing package:

1. Run npm install in the package root to install the current versions of all dependencies.

• Validate that the package works as expected with these versions.
• Run npm shrinkwrap, add npm-shrinkwrap.json to git, and publish your package.

To add or update a dependency in a shrinkwrapped package:

1. Run npm install in the package root to install the current versions of all dependencies.

• Add or update dependencies. npm install --save each new or updated package individually to update the package.json and the shrinkwrap. Note that they must be explicitly named in order to be installed: running npm install with no arguments will merely reproduce the existing shrinkwrap.
• Validate that the package works as expected with the new dependencies.
• Commit the new npm-shrinkwrap.json, and publish your package.

You can use npm-outdated to view dependencies with newer versions available.

Reference: npm-shrinkwrap documentation.