Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
assets
README.md
humans.txt
index.html
robots.txt

README.md

bonsai.js

Responsive jQuery tree for you and me

Contribution Guide

In the spirit of open source software development, we encourage community code contribution. To help you get started and before you jump into writing code, be sure to read these important contribution guidelines thoroughly.

What you need

In order to build bonsai front end assets, you need to have Node.js/npm latest and git 1.7 or later. (Earlier versions might work OK, but are not tested.)

For Windows you have to download and install git and Node.js.

Mac OS users should install Homebrew. Once Homebrew is installed, run brew install git to install git, and brew install node to install Node.js.

Linux/BSD users should use their appropriate package managers to install git and Node.js, or build from source if you swing that way. Easy-peasy.

Installing Grunt & Grunt Packages

First, clone a copy of this git repo by running:

git clone git://github.com/jpdevries/Bonsai.git

Install the grunt-cli and bower packages if you haven't before. These should be done as global installs:

npm install -g grunt-cli

Make sure you have grunt installed by testing:

grunt -version

Enter the default template directory and install the Node dependencies, this time without specifying a global(-g) install:

cd Bonsai/demo
npm install

Note: npm install updates dependencies and should be run whenever you pull from git.

To enable Growl notifications install terminal-notifier with RubyGems:

sudo gem install terminal-notifier

Grunt Commands

Build
Fetch dependencies, move items into place and compile by running:

grunt build

Watch
Compile the Sass and watch files for changes type the following:

grunt

Note: grunt is now watching files for changes. When Sass files are changed CSS will automatically be generated.
Install the LiveReload browser extension to inject CSS changes without a page refresh.

Ship
Compile Sass and minify for production by running:

grunt prod