Skip to content
Quick and easy product tours with Twitter Bootstrap Popovers
Branch: master
Clone or download
azizmashkour Merge pull request #708 from salbertson/patch-1
Add a "Reviewed by Hound" badge
Latest commit 65a4974 Nov 29, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
src #621 fix autoscroll when placement contains 'auto' Oct 8, 2018
test Remove smartPlacement option since Popper handles it Oct 8, 2017
.editorconfig Make the docs multipage Jan 26, 2014
.gitignore
.travis.yml
CNAME Add CNAME file Jan 31, 2014
LICENSE License change from Apache to MIT, approved by all contributors Nov 19, 2015
README.md
_config.yml
bower.json
coffeelint.json unfinished migration from grunt to gulp May 6, 2014
composer.json License change from Apache to MIT, approved by all contributors Nov 19, 2015
gulpfile.js Add Bootstrap util module to standalone build Oct 3, 2017
karma.conf.js Upgrade for Bootstrap 4 Oct 1, 2017
package.js first attempt to add library to meteor atmosphere Jul 13, 2014
package.json Rebuild node-sass to fix error in Travis Oct 8, 2017
smart.json
yarn.lock

README.md

Bootstrap Tour

Build Status Dependency Status devDependency Status NPM Version Reviewed by Hound

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.

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, yarn, and gulp's command line runner:

Debian/Ubuntu Linux
$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
$ sudo apt-get update && sudo apt-get install ruby-full yarn
Mac OS X
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew install ruby yarn
Development requirements
$ yarn global add gulp-cli
$ yarn
$ 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 MIT license. Documentation licensed under CC BY 3.0.

You can’t perform that action at this time.