Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shipshapecode/shepherd
Guide your users through a tour of your app
https://github.com/shipshapecode/shepherd
hacktoberfest shepherd tour
Last synced: 11 days ago
JSON representation
Guide your users through a tour of your app
- Host: GitHub
- URL: https://github.com/shipshapecode/shepherd
- Owner: shepherd-pro
- License: mit
- Created: 2013-12-17T06:30:27.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T14:56:52.000Z (6 months ago)
- Last Synced: 2024-05-22T15:27:03.499Z (6 months ago)
- Topics: hacktoberfest, shepherd, tour
- Language: TypeScript
- Homepage: https://shepherdpro.com/
- Size: 78.7 MB
- Stars: 11,888
- Watchers: 99
- Forks: 607
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-github-star - shepherd
- awesome - shepherd - Guide your users through a tour of your app (CSS)
- awesome-js-posts - Shepherd: Guide Your Users Through a Tour of Your App
- awesome-docs - Shepherd
- jimsghstars - shipshapecode/shepherd - Guide your users through a tour of your app (JavaScript)
README
[](http://badge.fury.io/js/shepherd.js)
[](https://app.fossa.com/projects/git%2Bgithub.com%shepherd-pro%2Fshepherd?ref=badge_shield)
[](https://github.com/shepherd-pro/shepherd/actions/workflows/test.yml)
[](https://codeclimate.com/github/shipshapecode/shepherd/maintainability)
[](https://codeclimate.com/github/shipshapecode/shepherd/test_coverage)
[](https://stackshare.io/shepherd-js)
[Shepherd](https://shepherdjs.dev/) 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
----------------------------------------------------------
| [
](http://godban.github.io/browsers-support-badges/)Edge | [
](http://godban.github.io/browsers-support-badges/)Firefox | [
](http://godban.github.io/browsers-support-badges/)Chrome | [
](http://godban.github.io/browsers-support-badges/)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.
# Demo
See Shepherd Live on our website by clicking on the image:
# 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](packages/react)
#### [Angular Shepherd Wrapper](https://github.com/shipshapecode/angular-shepherd)
#### [Vue Shepherd Wrapper](https://github.com/shipshapecode/vue-shepherd)
#### [Ember Shepherd Wrapper](https://github.com/shepherd-pro/ember-shepherd)
### Commercial license
If you want to use Shepherd for a commercial application, theme or plugin the commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase a commercial license at [shepherdjs.dev](http://shepherdjs.dev/pricing)
# 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](mailto:[email protected])!
## Resources
- [Website](https://shepherdjs.dev/)
- [Documentation](https://docs.shepherdjs.dev/)
- [Demo](https://shepherdjs.dev/)
- [Discord](https://discord.gg/EGcDW5NSud)
## Contributing
We encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md).
Our release process is mostly automated. For more details, see [RELEASE.md](RELEASE.md).
## Projects Already Using Shepherd
### [SimplePlanner](https://simpleplanner.io)
[SimplePlanner](https://simpleplanner.io) 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](https://code.tutsplus.com/series/building-your-startup-with-php--cms-742) which describes how Simple Planner was built.
### [LogSeq](https://logseq.com/)
[LogSeq](https://logseq.com/) uses Shepherd to guide users through initial setup steps.
### [Snapsure](https://snapsure.app)
[Snapsure](https://snapsure.app) uses Shepherd to help photographers learn how to set up alerts for their desired picture-perfect weather conditions.
### [Drupal](https://www.drupal.org/docs/8/core/modules/tour/overview)
The [Drupal](https://www.drupal.org/docs/8/core/modules/tour/overview) 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](https://github.com/JayP718/tour_shepherd_bb_plugin)
[Budibase](https://budibase.com/) is an open source application which allows you develop low code applications rapidly and efficiently.This [Budibase](https://budibase.com/) 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
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fshipshapecode%2Fshepherd?ref=badge_large)