LeanKit Node Client

The LeanKit client module for Node.js provides an easy-to-use set of functions designed to simplify the integration of external systems and utilities with your LeanKit account.

Requirements

• Node.js
• A LeanKit account

Installing the client

npm install leankit-client

Client usage

var LeanKitClient = require('leankit-client');
var client = LeanKitClient.createClient('account-name', '[email protected]', 'your-p@ssw0rd');

client.getBoards(function(err, res){
	console.log(res);
});

Review the tests for a full list of client functions and how to use them.

Proxy support

To use the LeanKit client behind a proxy server, pass an options object to the module constructor that includes the proxy server. For example:

var LeanKitClient = require('leankit-client');
var client = LeanKitClient.createClient('account-name', '[email protected]', 'your-p@ssw0rd', { 'proxy': 'http://localproxy.com' } );

This options object is the same object used by the request module.

Installing Manually

• Clone or download the leankit-node-client Github repository.

• Open a Terminal window, change to the repository folder, and install dependent packages.

    npm install
  

• Create a folder in your node application's node_modules folder named leankit-client (e.g. `[project-name]/node_modules/leankit-client).

• Copy all the files and folders in the leankit-node-client folder to the leankit-client folder created in the previous step.

Compiling leankit-client.js

The LeanKit client for Node.js is written in CoffeeScript. To make changes, you'll need the CoffeeScript compiler.

npm install -g coffee-script

Next, compile the LeanKit client module using:

coffee --compile leankit-client.coffee

Running Tests

• Set environment variables for the LeanKit account you wish to test with.

  OSX/Linux

    export LEANKIT_ACCOUNT=your-account-name
    export [email protected]
    export LEANKIT_PASSWORD=your-p@ssw0rd
    export LEANKIT_TEST_BOARD=name-of-your-test-board
  

  Windows

    setx LEANKIT_ACCOUNT "your-account-name"
    setx LEANKIT_EMAIL "[email protected]"
    setx LEANKIT_PASSWORD "your-p@ssw0rd"
    setx LEANKIT_TEST_BOARD "name-of-your-test-board"
  

  Note: On Windows, you will need to reopen your command prompt after setting environment variables.

• Install Mocha

    npm install -g mocha
  

• Open Terminal and change to the LeanKit Node Client directory

• Run Mocha, specifying a reporter

    mocha --reporter spec
  

Questions?

Visit support.leankit.com.

License

The LeanKit Node Client is licensed under MIT. Refer to license.txt for more information.