shepherd README

The project's README from github.com/shipshapecode/shepherd. As one markdown file: README.md.

Shepherd.js Logo

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

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.

Demo

See Shepherd Live on our website by clicking on the image: Guide your users through a tour of your app

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.

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

FOSSA Status

shepherd (shipshapecode/shepherd)

Searching Database…

13.8K ·GitHub
Shepherd
这是什么?Shepherd 是一个开源 JavaScript 库,用于在你的网页应用中构建分步骤的产品导览、新用户引导流程和功能公告。
这是独立的库还是完整的平台?核心产品是一个客户端 JavaScript 库,你可以将其嵌入应用中,并提供 React、Angular、Vue 和 Ember 的官方封装。此外还有一项单独收费的“白手套”服务,由 Shepherd 团队替你制作导览。
怎样把它添加到我的项目中?可以直接使用 shepherd.js 包,配合 ES 模块或普通 JavaScript;也可以引入适合你技术栈的 React、Angular、Vue 或 Ember 专用封装包。
它支持哪些框架?Shepherd 支持 React、Ember、Angular、Vue.js、原生 ES 模块以及原生 JavaScript,因此不强制依赖任何框架。
Shepherd 能否免费用于商业产品?仅限开源和非商业用途。Shepherd.js 采用双重授权,分别为 AGPL-3.0 和单独的商业许可证,因此以盈利为目的的公司需要购买商业许可证。
它支持哪些浏览器?官方支持 Edge、Firefox、Chrome 和 Safari 的最近两个版本。
哪些项目已在生产环境中使用 Shepherd?LogSeq、Drupal、Budibase 和 SimplePlanner 等项目都使用 Shepherd 来驱动其应用内的新用户引导导览。
什么是白手套服务?这是一项可选的收费服务,由 Shepherd 团队为你的产品定制导览、培训或新用户引导体验,无需你自己动手制作。
导览的外观能有多大程度的自定义?Shepherd 默认只提供极简的样式,因此你可以大幅定制外观,同时开箱即可获得分步骤的导览效果。
What are similar projects?sweetalert2, material, chakra-ui, tui.editor, bootstrap-table, shaders, tabler-icons, intro.js
Which topics is it in?angular, saas, javascript-library, design, agpl, vue, customization, browser, documentation, hacktoberfest, ui, productivity
Creator
shipshapecode
Size
92.1 MB
Stars
13.8K
Updated
CommitOct 07Releasev7.0.6-react-shepherdAug 24
Age
12y
Commits · 90 Days