JSPM – vso-client@0.0.1

Package Exports

vso-client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vso-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Visual Studio Online Node.js Client

The VSO 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 Visual Studio Online account.

Requirements

Node.js
A Visual Studio Online account

Installing the client

npm install vso-client

Client usage

var Client = require('vso-client');
var client = Client.createClient('url', 'collection', 'your-username', 'your-p@ssw0rd');

client.getProjects(function(err, projects) {
    console.log(projects);
});

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

Developing from Source

The VSO client is written in CoffeeScript. To modify and rebuild the client from source, you will need the CoffeeScript compiler. Gulp.js is used to automatically build the client and run all mocha tests.

Clone or download the vso-node-client Github repository.

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

  npm install -g coffee-script
  npm install -g gulp
  npm install -g mocha
  npm install -g should
  npm install
  npm install --package-dev

Add environment variables for integration tests

OS X / Linux

export VSO_URL=your-vso-account-URL
export VSO_COLLECTION=your-project-collection
export VSO_USER=your-username
export VSO_PWD=your-password

Windows

setx VSO_URL "your-vso-account-URL"
setx VSO_COLLECTION "your-project-collection"
setx VSO_USER "your-username"
setx VSO_PWD "your-password"

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

Keep gulp running to compile the /src folder and run mocha tests in the /spec folder.
```
  gulp
```

Installing manually

Create a folder in your node application's node_modules folder named vso-client (e.g. `[project-name]/node_modules/vso-client).
Copy all the files and folders in the vso-node-client folder to the vso-client folder created in the previous step.

License

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