newsource-elastic-module

Elasticsearch Module

This repository is a Node.js Module to encapsulate logic related to interacting with Elasticsearch for the Newsource Portal project.

Setup

Run one of the following commands in the root directory of your project

#!shell

npm install git+ssh://[e-mail]:EATurner/newsource-elastic-module.git
npm install git+https://[YourUsername]@bitbucket.org/EATurner/newsource-elastic-module.git

Using as a dependency in your project

Add only one of the following lines to your package.json dependencies object

#!shell

 "newsource-elastic-module": "git+ssh://[e-mail]:EATurner/newsource-elastic-module.git"
 "newsource-elastic-module": "git+http://[YourUsername]@bitbucket.org:EATurner/newsource-elastic-module.git"

Versioning

If you want to sync your Git commit with the version of your module

#!shell

git tag [major].[minor].[patch]
git push origin master --tags

If you want to install a specific version of this module, run one of the following commands

#!shell

npm install git+ssh://[e-mail]:EATurner/newsource-elastic-module.git#[major].[minor].[patch]
npm install git+https://[YourUsername]@bitbucket.org/EATurner/newsource-elastic-module.git#[major].[minor].[patch]

TODO

• Specify how to run tests