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

Shepherd is an open source, fully featured, digital adoption platform (DAP) and user on-boarding service. Use our hosted SaaS or deploy to your own infrastructure to run on-premise.

Supported Browsers

<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" /></br>Edge	<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" /></br>Firefox	<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" /></br>Chrome	<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" /></br>Safari
Edge	last 2 versions	last 2 versions	last 2 versions

Shepherd

Shepherd makes it simple to create custom user on-boarding tours, trainings and announcements to drive user adoption.

Shepherd enables you to guide users through a custom tour or journey within your app or website. Highly customizable with minimal styles, Shepherd allows for powerful customization while being easy to use. Various frameworks supported including React, Ember, Angular, Vue.js, ES Modules, or plain JavaScript.

Shepherd Pro

Unlock additional capabilities and more full featured Journeys.

• Customizable Tour Templates: Pre-designed templates for different types of software that can be easily customized.
• Analytics Integration: To track user engagement and effectiveness of the tours.
• Multi-Language Support: For global reach and accessibility.
• User Behavior Tracking: To understand how users interact with the tours and optimize accordingly.
• Integration Capabilities: Easy integration with a wide range of web applications and software.
• Responsive Design: Ensuring tours work seamlessly on all devices.
• Feedback Mechanisms: Allowing users to provide feedback directly within the tours.
• Advanced Branching Logic: For personalized tour experiences based on user actions or profiles.

Demo

See Shepherd Live on our docs website by clicking on the image: <a href="https://blog.shepherdpro.com/demo"> <img src="https://blog.shepherdpro.com/img/demo.png" alt="Guide your users through a tour of your app" style="height: auto; max-width: 800px; width: 100%;"/> </a>

Using Shepherd

Shepherd Pro hosted SaaS (Alpha)

You can try our hosted version for free at https://shepherdpro.com/

The Entire Shepherd Service that powers Shepherd Pro is the newest iteration of Shepherd and includes the features of Shepherd Pro. You can set that up on your own infrastructure by using our Docker File, located here.

Shepherd Library (MIT License)

The Shepherd Standalone Library has been open source since the very beginning. Check out our tutorials here:

React Shepherd Wrapper

Angular Shepherd Wrapper

Vue Shepherd Wrapper

Ember Shepherd Wrapper

White Glove Services

If you have an idea or project in mind and would like to engage our team to build a custom tour, training or on-boarding experience, get in touch! hello@shepherdpro.com

Resources

• Website
• Documentation
• Demo
• Discord
• If you have any questions about our projects you can email hello@shepherdpro.com

Contributing

We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing. Our release process is mostly automated. For more details, see RELEASE.md.

Projects Already Using Shepherd

SimplePlanner

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.

LogSeq

LogSeq uses Shepherd to guide users through initial setup steps.

Snapsure

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

Drupal

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.

Budibase Shepherd Tour Plugin

Budibase is an open source application which allows you develop low code applications rapidly and efficiently.This Budibase Shepherd tour plugin allows you to create interative walkthroughs for your application.

Your Project Here

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

License