Skip to content

Latest commit

 

History

History
executable file
·
34 lines (21 loc) · 990 Bytes

BUILD.md

File metadata and controls

executable file
·
34 lines (21 loc) · 990 Bytes
Raw

This document is a guide to help you build buckets.js and buckets.min.js from scratch. It may help you in case you modify the source files.

Installing dependencies

  1. Install Node.js
  2. Install Grunt CLI: npm install -g grunt-cli
  3. Run npm install from the current directory to download Grunt development dependencies.

Building

Run grunt from the current directory.

This will read all the files inside src/ and create buckets.js, buckets.min.js, run all tests inside test/ and generate documentation.

Generating documentation

Run grunt doc from the current directory.

Testing

Run grunt test from the current directory.

There are a few other commands defined in gruntfile.js. Check them out.

Additional information