Sheperd

Guide your users through a tour of your app

README

  <img
    alt="Shepherd.js Logo"
    src="https://i.imgur.com/cowwtSX.png"/>

Ship Shape
npm version
Download count all time
npm FOSSA Status
npm bundle size Test Maintainability Test Coverage StackShare


  <img
    src="https://shepherdjs.dev/landing/assets/img/demo.png"
    alt="Guide your users through a tour of your app"
    style="height: auto; max-width: 800px; width: 100%;"/>

Browsers support

[[[[
------------------------------------
Edge|lastlast


Documentation


Demo


Contributing

We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing.

License

Projects Using Shepherd

Here we showcase some of the awesome libraries built using Shepherd.

JS Framework Wrappers



Ember addon for the site tour library Shepherd


An Angular wrapper for the site tour library Shepherd


A React wrapper for the site tour library Shepherd


A Vue wrapper for the site tour library Shepherd

Rails gems



Rails engine that generates and tracks Shepherd tours within an application

Websites and Apps



SimplePlanner uses Shepherd to help new users get familiar with its collaborative scheduling approach.
You do need to sign up via OAuth or email to see the scheduling tour.
Check out the Envato Tuts+ Startup Series on its codebase which describes how Simple Planner was built.


Brokermate uses Shepherd to guide users through initial setup steps.


Snapsure uses Shepherd to help photographers learn how to set up alerts for their desired picture-perfect weather conditions.



The Drupal CMS uses Shepherd to offer tours of it's core modules, and allows developers to add Tours to their custom and contributed modules.



Your Project Here


If you have a cool open-source library built on Shepherd, PR this doc.


License FOSSA Status