Riak Node.js Client is a client which makes it easy to communicate with Riak, an open source, distributed database that focuses on high availability, horizontal scalability, and predictable latency. Both Riak and this code is maintained by Basho.
- Master:
npm install basho-riak-client --save
Most documentation is living in the wiki. For specifics on our progress here, see the release notes.
This repository's maintainers are engineers at Basho and we welcome your contribution to the project! Review the details in CONTRIBUTING.md in order to give back to this project.
Note: Please clone this repository in such a manner that submodules are also cloned:
git clone --recursive https://github.com/basho/riak-nodejs-client
OR:
git clone https://github.com/basho/riak-nodejs-client
git submodule update --init --recursive
make unit-testYou have two options to run Riak locally - either build from source, or use a pre-installed Riak package.
To setup the default test configuration, build a Riak node from a clone of github.com/basho/riak:
# check out latest release tag
git checkout riak-2.1.4
make locked-deps
make relWhen building from source, the protocol buffers port will be 8087 and HTTP will be 8098.
Install using your platform's package manager (docs)
When installing from a package, the protocol buffers port will be 8087 and HTTP will be 8098.
- Ensure you've initialized this repo's submodules:
git submodule update --init- Run the following:
./tools/setup-riak
make integration-testThe Riak Node.js Client will support Node.js releases according to the LTS schedule.
The Riak Node.js Client is Open Source software released under the Apache 2.0 License. Please see the LICENSE file for full license details.
- Author: Brian Roach
- Author: Luke Bakken
- Author: Bryce Kerley
Thank you to all of our contributors!