What is this?
Shepherd is an open source JavaScript library for building step-by-step product tours, on-boarding flows and feature announcements inside your web app.
Shepherd is an open source JavaScript library for building step-by-step product tours, on-boarding flows and feature announcements inside your web app.Is this a standalone library or a full platform?The core product is a client-side JavaScript library you embed in your app, with official wrappers for React, Angular, Vue and Ember; there is also a separate paid 'white glove' service where Shepherd's own team builds the tour for you.
The core product is a client-side JavaScript library you embed in your app, with official wrappers for React, Angular, Vue and Ember; there is also a separate paid 'white glove' service where Shepherd's own team builds the tour for you.How do I add it to my project?Use the shepherd.js package directly with ES modules or plain JavaScript, or pull in the dedicated React, Angular, Vue or Ember wrapper for your stack.
Use the shepherd.js package directly with ES modules or plain JavaScript, or pull in the dedicated React, Angular, Vue or Ember wrapper for your stack.Which frameworks does it work with?Shepherd works with React, Ember, Angular, Vue.js, plain ES Modules, or vanilla JavaScript, so it has no mandatory framework dependency.
Shepherd works with React, Ember, Angular, Vue.js, plain ES Modules, or vanilla JavaScript, so it has no mandatory framework dependency.Is Shepherd free to use in a commercial product?Only for open source and non-commercial use. Shepherd.js is dual-licensed under AGPL-3.0 and a separate commercial license, so revenue-generating companies need to purchase the commercial license.
Only for open source and non-commercial use. Shepherd.js is dual-licensed under AGPL-3.0 and a separate commercial license, so revenue-generating companies need to purchase the commercial license.Which browsers does it support?Officially the last two versions of Edge, Firefox, Chrome and Safari.
Officially the last two versions of Edge, Firefox, Chrome and Safari.Who already uses Shepherd in production?Projects like LogSeq, Drupal, Budibase and SimplePlanner use Shepherd to power their in-app onboarding tours.
Projects like LogSeq, Drupal, Budibase and SimplePlanner use Shepherd to power their in-app onboarding tours.What is the White Glove service?It's an optional paid service where the Shepherd team builds a custom tour, training or on-boarding experience for your product instead of you building it yourself.
It's an optional paid service where the Shepherd team builds a custom tour, training or on-boarding experience for your product instead of you building it yourself.How customizable is the look of a tour?Shepherd ships with minimal default styling so you can heavily customize the appearance while still getting step-by-step tour behavior out of the box.
Shepherd ships with minimal default styling so you can heavily customize the appearance while still getting step-by-step tour behavior out of the box.What are similar projects?sweetalert2, material, chakra-ui, tui.editor, bootstrap-table, shaders, tabler-icons, intro.js
sweetalert2, material, chakra-ui, tui.editor, bootstrap-table, shaders, tabler-icons, intro.jsWhich topics is it in?angular, saas, javascript-library, design, agpl, vue, customization, browser, documentation, hacktoberfest, ui, productivity
angular, saas, javascript-library, design, agpl, vue, customization, browser, documentation, hacktoberfest, ui, productivity