xfe-node

| Info | Badges | | ------------- | ------------- | | License | | | Testing | | | Quality | | | Stats |

Description

xfe-node is a Node.js library for interacting with the IBM X-Force Exchange. It provides a wrapper around the API which you can use directly and also provides some convenience functionality.

Installation

First, install npm on your machine. Then install the library in your project with

npm install xfe --save

How to Use

Obtain an API username and password

var xfe = require("xfe");
var xfeClient = new xfe("api username", "api password");

xfeClient.ipr.get("1.2.3.4").then(function(response) {
  console.log(response);
})

View full interface documentation here.

Support

If you are having any questions or issues getting things to work, you can:

• Ask a question in IBM DeveloperWorks Answers under the xfe-node tag.

Project's issue on GitHub should be used discuss bugs and features.

Contributing to the project

We welcome any contributions to the project. Please check the CONTRIBUTING.md for contribution guidelines.

Check out our contributors here

Development

Prepare your environment

• Install Node.js and NPM (should come with)
• Install global dev dependencies: npm install -g gulp
• Install local dev dependencies: npm install while current directory is xfe-node repo

Build

• Build the whole project: gulp - this will run lint, build, and test targets

Release

• Use GitHub's release tool to draft and publish a release. I like the format better than changelogs.