https://github.com/sorich87/bootstrap-tour

Quick and easy product tours with Twitter Bootstrap Popovers
https://github.com/sorich87/bootstrap-tour

Last synced: 29 days ago
JSON representation

Quick and easy product tours with Twitter Bootstrap Popovers

• Host: GitHub
• URL: https://github.com/sorich87/bootstrap-tour
• Owner: sorich87
• License: mit
• Created: 2012-07-03T14:03:49.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2023-10-09T22:35:49.000Z (about 1 year ago)
• Last Synced: 2024-10-09T23:33:28.282Z (about 1 month ago)
• Language: CoffeeScript
• Homepage: http://bootstraptour.com
• Size: 3.69 MB
• Stars: 4,436
• Watchers: 143
• Forks: 941
• Open Issues: 194
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-javascript-cn - 官网
• awesome-javascript - bootstrap-tour - Quick and easy product tours with Twitter Bootstrap Popovers - ★ 4156 (Tours And Guides)

README

        
# Bootstrap Tour

[![Build Status](http://img.shields.io/travis/sorich87/bootstrap-tour.svg?style=flat)](https://travis-ci.org/sorich87/bootstrap-tour)

[![Dependency Status](http://img.shields.io/david/sorich87/bootstrap-tour.svg?style=flat)](https://david-dm.org/sorich87/bootstrap-tour)

[![devDependency Status](http://img.shields.io/david/dev/sorich87/bootstrap-tour/dev-status.svg?style=flat)](https://david-dm.org/sorich87/bootstrap-tour#info=devDependencies)

[![NPM Version](http://img.shields.io/npm/v/bootstrap-tour.svg?style=flat)](https://www.npmjs.org/)

[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)

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

*Compatible with Bootstrap >= 2.3.0*

## Demo and Documentation

[http://bootstraptour.com](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](http://gulpjs.com/).

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

We use [Gulp](http://gulpjs.com/) and [Jasmine](http://jasmine.github.io/). 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

```bash

$ 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

```bash

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

$ brew install ruby yarn

```

##### Development requirements

```bash

$ 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](http://dean.io/setting-up-a-ruby-on-rails-development-environment-on-mavericks/) before you can install Jekyll.

#### Gulp usage

Run gulp and start to develop with ease:

```bash

$ 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](https://opensource.org/licenses/MIT).

Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).