JS Girder Client

Automagic Girder Communication

JavaScript client for a Girder server.

js-girder-client is a JavaScript library for interacting with a girder server instance. The library can be used inside NodeJS or within a browser. In addition, a command line interface is also provided that allows complex actions to be scripted.

Simple

Easy to use from NodeJS, within a browser, or as a command-line tool.

Fast

No clicking or typing.

Clean

Using a simple Javascript function, Girder content comes out.

Getting Started

js-girder-client can be retrieved using npm.

npm

~ $ npm install -g js-girder-client

Quick-start

For the impatient, here's how to get boilerplate js-girder-client up and running.

~ $ git clone git@github.com:Kitware/js-girder-client.git
~ $ cd js-girder-client
~/js-girder-client $ npm install
~/js-girder-client $ npm run test:basic
# => Now browse to http://localhost:3000

Documentation

See the documentation for a getting started guide, advanced documentation, and API descriptions.

Licensing

JS Girder Client is licensed under BSD 3 Clause Open Source License.

Getting Involved

Fork the js-girder-client repository and do great things. At Kitware, Inc., we want to make js-girder-client useful to as many people as possible.