Installation

This article will show you how you can include the Riak NodeJS Client in your project in preparation for communicating with your Riak cluster.

Note: Please use the --recursive git option or run git submodule update --init after cloning as a couple submodules are used. Thanks!

NPM

The easiest way to install libraries in your project is to use NPM. The Riak NodeJS Client has an NPM package package available which can be installed directly into your project's packages.json file:

npm install --save basho-riak-client

GitHub

All of the binary releases, along with the dependencies, are also available directly from the GitHub releases download page.

Source Code

If you're doing this, you're a developer who probably doesn't need much hand-holding, so we'll keep this bit brief. Get yourself a git client and type:

git clone git://github.com/basho/riak-nodejs-client.git

This will pull down the source and update your working folder to the latest development code.

Building From Source

• Ensure NodeJS 0.12 or later is installed

• Ensure the npm command is available.

• Clone and build it:

  git clone --recursive git://github.com/basho/riak-nodejs-client.git
  cd riak-nodejs-client
  make install-deps
  make unit-test