back to home

shipshapecode / shepherd

Guide your users through a tour of your app

13,646 stars
652 forks
36 issues
JavaScriptTypeScriptAstro
Chat with CodebaseArchitecture ScanSecurity AuditExplain Codebase

AI Architecture Analysis

This repository is indexed by RepoMind. By analyzing shipshapecode/shepherd in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.

Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.

Click here to launch the interactive analysis workspace

Embed this Badge

Showcase RepoMind's analysis directly in your repository's README.

[![Analyzed by RepoMind](https://img.shields.io/badge/Analyzed%20by-RepoMind-4F46E5?style=for-the-badge)](https://repomind-ai.vercel.app/repo/shipshapecode/shepherd)
Preview:Analyzed by RepoMind

Repository Summary (README)

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

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

Shepherd is an open source, fully featured, digital adoption platform (DAP) and user on-boarding service.

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
Edgelast 2 versionslast 2 versionslast 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.

Demo

See Shepherd Live on our website by clicking on the image: <a href="https://shepherdjs.dev"> <img src="https://shepherdjs.dev/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 Open Source Library

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!

Resources

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

Rails gems

abraham

Rails engine that generates and tracks Shepherd tours within an application

Websites and Apps

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

Shepherd.js is dual-licensed under AGPL-3.0 and a Commercial License.

  • Free for open source and non-commercial use under AGPL-3.0
  • Commercial license required for commercial products and revenue-generating companies

See LICENSE.md for complete details or visit shepherdjs.dev/pricing to purchase a commercial license.

FOSSA Status