rakibamin / bootstrap-tour

Quick and easy product tours with Twitter Bootstrap Popovers

Bootstrap Tour

Quick and easy way to build your product tours with Bootstrap Popovers.

Compatible with Bootstrap >= 2.3.0

Demo and Documentation

http://bootstraptour.com

Contributing

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 Gulp.

Feel free to contribute with pull requests, bug reports or enhancement suggestions.

The license of Bootstrap Tour is Apache for now. However, the project intends to move to the MIT license like Bootstrap has. All the biggest contributors are ok with the change and thus, all new contributions as of 2015-07-22 are to be with the MIT license. And once all previous contributors have approved the change (or their code has been removed), the project will become licensed MIT. Please see: sorich87#257

We use Gulp and Jasmine. Both make your life easier ;)

Develop

Files to be developed are located under ./src/. Compiled sources are then automatically put under ./build/, ./test/ and ./docs/.

Requirements

To begin, you need a few standard dependencies installed. These commands will install ruby, gem, node, npm, and grunt's command line runner:

Linux

$ sudo apt-get install ruby
$ sudo apt-get install ruby-dev
$ sudo apt-get install npm
$ sudo apt-get install nodejs-legacy

Mac OS X

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
\curl -L https://get.rvm.io | bash
rvm install ruby-2.1.1
brew install node

Development requirements

$ npm install -g gulp
$ 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.

Gulp usage

Run gulp and start to develop with ease:

$ gulp
$ gulp dist
$ gulp test
$ gulp docs
$ gulp clean
$ gulp server
$ gulp bump --type minor (major.minor.patch)

Check gulpfile.coffee to know more.

License

Code licensed under the Apache License v2.0. Documentation licensed under CC BY 3.0.