/leaflegend

Primary LanguageJavaScriptMIT LicenseMIT

leaflegend

interactive legend for leafletjs supporting bivariate choropleth maps

About

A JavaScript library by 320ryder.

See the demo.

setting up for development

We are using Yeoman for generating library, GRUNT for tasks and Bower for packaging.

You could use Homebrew to install npm.

make sure you have installed npm. If using *NIX machines you can use Homebrew:

brew install npm

install yo with:

npm install -g yo

install bower with:

npm install -g bower

install the yo's library generator with:

npm install -g generator-lib

you can use npm to install GRUNT:

npm install -g grunt-cli

if the grunt plugins are not installed you can run npm install when cd'd in the project directory.

Fork the reposotiry then clone your fork of the repository from GitHub and cd into it. run the grunt tasks with:

grunt

for just compiling coffee to js run:

grunt coffee

for watching the coffee files for automatic compiling use:

grunt watch

Documentation

Start with docs/MAIN.md.

Contributing

We'll check out your contribution if you:

  • Provide a comprehensive suite of tests for your fork.
  • Have a clear and documented rationale for your changes.
  • Package these up in a pull request.

We'll do our best to help you out with any contribution issues you may have.

License

MIT. See LICENSE.txt in this directory.