Intro brings your rails application to new feature introduction and step-by-step users guide.
Intro injects dynamically-generated Shepherd.js code into your application whenever user should see a guided tour.
intro to application's Gemfile:
And then execute:
$ bundle install
Copy migrations and configurations:
$ rails generate intro:install
Then do migrate:
$ bundle exec rake db:migrate
intro_tags into common layout, just before the closing body tag:
<%= intro_tags %> </body> </html>
intro_tags imports assets of intro and adds
_intro global variable with options.
intro_tags must be inserted into body tag for refreshing
_intro variable if you need to use Turbolinks.
http://localhost:3000/intro/admin to backstage after starting server. In
config/initializers/intro.rb file, you can get the default username and password for logining.
Then add tour and define content. After filling out the content, you need to publish tour.
If the default style doesn't satisfy you, you need to run assets generator:
$ rails generate intro:assets
Then you would get the asset files:
Change them for your need.
config/initializers/intro.rb for detail configuration.
Bug report or pull request are welcome.
Please write unit test with your code if necessary.
The gem is available as open source under the terms of the MIT License.