cilantro

Client library for Serrano-compatible APIs

npm install cilantro
4 downloads in the last week
4 downloads in the last month

Cilantro

Build Status Bitdeli Badge devDependency Status

Development

Interested in contributing? Please read the CONTRIBUTING.md guide prior to sending pull requests.

Dependencies

  • Node + NPM
  • Ruby + Sass

Setup

# Clone the cilantro repo or a fork; go into the directory
git clone git@github.com/cbmi/cilantro.git && cd cilantro

# Installs the dev depenencies including Grunt
npm install

# Run Grunt 'work' task to perform the initial compilation of .coffee
# and .scss files, it finishes by starting a `watch` process
grunt work

Testing

To run the tests, simply do:

grunt test

Distribution

Distribution builds should only be created off the develop branch. This:

  • Bumps the version to the final, e.g. 2.0.3-beta to 2.0.3
  • Tags a release
  • Freshly compiles and optimizes code
  • Creates zip and tarball binaries
  • Prints instructions to push and upload it to GitHub
  • Bumps the patch version, e.g. 2.0.3 to 2.0.4-beta
grunt release
npm loves you