• Stars
    star
    11,579
  • Rank 2,862 (Top 0.06 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 11 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Guide your users through a tour of your app

Shepherd.js Logo

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

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

IE / Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
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: Guide your users through a tour of your app

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: [https://github.com/shepherd-pro/shepherd/blob/main/app/Dockerfile]

Shepherd Library (MIT License)

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

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! [email protected]

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

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 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.

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

FOSSA Status

More Repositories

1

tether

A positioning engine to make overlays, tooltips and dropdowns better
JavaScript
8,489
star
2

react-shepherd

A React wrapper for the site tour library Shepherd
CSS
549
star
3

vue-shepherd

A Vue wrapper for the site tour library Shepherd
Vue
260
star
4

angular-shepherd

An Angular wrapper for the site tour library Shepherd
TypeScript
196
star
5

ember-cli-release

Ember CLI addon for versioned release management
JavaScript
90
star
6

swach

A robust color management tool for the modern age
TypeScript
52
star
7

ember-prism

Easy ember components for syntax highlighting a-la PrismJS
TypeScript
34
star
8

ember-cli-capacitor

Add Capacitor to your Ember app.
JavaScript
29
star
9

ember-x-editable

X-editable like library for Ember
JavaScript
22
star
10

ember-3d-nav

A 3d rotating top navigation bar for Ember apps
JavaScript
21
star
11

website-ember

The code for shipshape.io
JavaScript
20
star
12

website-nuxt

Nuxt port of shipshape.io
Vue
16
star
13

ember-cli-netlify

Ember addon to configure Netlify headers and redirects
JavaScript
14
star
14

ember-drop

An Ember addon that wraps Drop.js
JavaScript
11
star
15

website-astro

The code for the current Ship Shape website
Astro
6
star
16

prember-sitemap-generator

A sitemap generator for prember apps
JavaScript
6
star
17

ember-service-worker-prember

An Ember Service Worker plugin that caches the index.html files for each prember route
JavaScript
6
star
18

ember-3d-folding-panel

An Ember addon for 3d folding panels
JavaScript
5
star
19

starpod

Starpod: Create an amazing podcast website in 5 minutes
TypeScript
5
star
20

ember-headroom

Ember addon to include headroom.js as an ES2015 module in your app
JavaScript
4
star
21

ember-performance-workshop

The code for the EmberConf 2018 Performance Workshop
HTML
4
star
22

ember-newton-cradle-loader

Ember addon for showing a newton cradle loading animation
JavaScript
4
star
23

ember-async-await-for-each

async/await aware forEach for Ember
JavaScript
4
star
24

prember-rss-feed

Ship RSS feeds for your Prember site
JavaScript
3
star
25

ember-assign-polyfill

A polyfill for Ember.assign in <= 2.4
JavaScript
2
star
26

ember-journal

A blogging engine for Ember apps
JavaScript
2
star
27

ember-isometric-grids

JavaScript
2
star
28

bootcamp-loader

TypeScript
1
star
29

1787-astro

Astro
1
star
30

ember-debonair

Get your Ember code in ship shape
JavaScript
1
star
31

ember-showdown-highlight

JavaScript
1
star
32

glimmer-context-menu

TypeScript
1
star
33

www-website

whiskeywebandwhatnot.fm
JavaScript
1
star