Quick and easy way to build your product tours with Bootstrap Popovers.
Compatible with Bootstrap >= 2.3.0
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Feel free to contribute with pull requests, bug reports or enhancement suggestions.
We use Grunt and Jasmine. Both make your lives easier ;)
Files to be developed are located under ./src/
Compiled sources are then automatically put under ./build/
(and ./test/
)
To begin, you need a few standard dependencies installed. These commands will install ruby, gem, node, npm, and grunt's command line runner:
sudo apt-get install ruby
sudo apt-get install ruby-dev
sudo apt-get install npm
sudo apt-get install nodejs-legacy
sudo npm install -g grunt-cli
Once those are installed, you can run (note these don't need to be run with sudo):
npm install
gem install jekyll
For Mac OS X Mavericks (10.9) users: You will need to jump through all these hoops before you can install Jekyll.
// Start a server and run the demo page
grunt
grunt go
// Compile all sources
grunt build
// Compile all sources and run the tests
grunt test
// Automatically release a new version
grunt release // patch release
grunt release:minor // minor release
grunt release:major // major release
Check Gruntfile.coffee
for more infos.
Code licensed under the Apache License v2.0. Documentation licensed under CC BY 3.0.