{"id":13824420,"url":"https://github.com/shipshapecode/shepherd","last_synced_at":"2025-05-13T17:04:12.446Z","repository":{"id":12576396,"uuid":"15246993","full_name":"shipshapecode/shepherd","owner":"shipshapecode","description":"Guide your users through a tour of your app","archived":false,"fork":false,"pushed_at":"2025-05-06T12:06:46.000Z","size":91456,"stargazers_count":13182,"open_issues_count":54,"forks_count":650,"subscribers_count":96,"default_branch":"main","last_synced_at":"2025-05-06T16:16:51.987Z","etag":null,"topics":["hacktoberfest","shepherd","tour"],"latest_commit_sha":null,"homepage":"https://shepherdjs.dev","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shipshapecode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"rwwagner90"}},"created_at":"2013-12-17T06:30:27.000Z","updated_at":"2025-05-06T12:04:47.000Z","dependencies_parsed_at":"2023-09-28T03:32:59.147Z","dependency_job_id":"f2ce0005-8e2c-47a8-bbc0-1ad938ac33e8","html_url":"https://github.com/shipshapecode/shepherd","commit_stats":{"total_commits":2852,"total_committers":123,"mean_commits":23.1869918699187,"dds":0.6507713884992987,"last_synced_commit":"af4d0c63fcf0a5c8eda8a2711bb37de64ec74eb9"},"previous_names":["hubspot/shepherd","shepherd-pro/shepherd","shipshapecode/shepherd"],"tags_count":259,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipshapecode%2Fshepherd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipshapecode%2Fshepherd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipshapecode%2Fshepherd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipshapecode%2Fshepherd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shipshapecode","download_url":"https://codeload.github.com/shipshapecode/shepherd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253346347,"owners_count":21894262,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","shepherd","tour"],"created_at":"2024-08-04T09:01:02.504Z","updated_at":"2025-05-13T17:04:12.422Z","avatar_url":"https://github.com/shipshapecode.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg \n    alt=\"Shepherd.js Logo\"\n    src=\"https://i.imgur.com/cowwtSX.png\"/\u003e\n\u003c/p\u003e\n  \n\n[![npm version](https://badge.fury.io/js/shepherd.js.svg)](http://badge.fury.io/js/shepherd.js)\n![Download count all time](https://img.shields.io/npm/dt/shepherd.js.svg)\n![npm](https://img.shields.io/npm/dm/shepherd.js.svg)\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fshipshapecode%2Fshepherd.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%shipshapecode%2Fshepherd?ref=badge_shield)\n![npm bundle size](https://img.shields.io/bundlephobia/minzip/shepherd.js.svg)\n[![Test](https://github.com/shipshapecode/shepherd/actions/workflows/test.yml/badge.svg)](https://github.com/shipshapecode/shepherd/actions/workflows/test.yml)\n[![Maintainability](https://api.codeclimate.com/v1/badges/b295b0cc0d828ccc1b76/maintainability)](https://codeclimate.com/github/shipshapecode/shepherd/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/b295b0cc0d828ccc1b76/test_coverage)](https://codeclimate.com/github/shipshapecode/shepherd/test_coverage)\n[![StackShare](https://img.shields.io/badge/Follow%20on-StackShare-blue.svg?logo=stackshare\u0026style=flat)](https://stackshare.io/shepherd-js)  \n\n[Shepherd](https://shepherdjs.dev/) is an open source, fully featured, digital adoption platform (DAP) and user on-boarding service. Use our\nhosted SaaS or deploy to your own infrastructure to run on-premise.\n\nSupported Browsers\n----------------------------------------------------------\n\n| [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\" alt=\"IE / Edge\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eEdge | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png\" alt=\"Firefox\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eFirefox | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png\" alt=\"Chrome\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eChrome | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png\" alt=\"Safari\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003c/br\u003eSafari |\n| --------- | --------- | --------- | --------- |\n| Edge| last 2 versions| last 2 versions| last 2 versions\n\n# Shepherd\n\nShepherd makes it simple to create custom user on-boarding tours, trainings and announcements to drive user adoption. \n\nShepherd 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. \n\n# Demo\nSee Shepherd Live on our website by clicking on the image:\n\u003ca href=\"https://shepherdjs.dev\"\u003e\n  \u003cimg \n    src=\"https://shepherdjs.dev/img/demo.png\" \n    alt=\"Guide your users through a tour of your app\" \n    style=\"height: auto; max-width: 800px; width: 100%;\"/\u003e\n\u003c/a\u003e\n\n# Using Shepherd\n\n### Shepherd Open Source Library\n\nThe Shepherd Standalone Library has been open source since the very beginning. Check out our tutorials here:\n\n#### [React Shepherd Wrapper](packages/react)\n#### [Angular Shepherd Wrapper](https://github.com/shipshapecode/angular-shepherd)\n#### [Vue Shepherd Wrapper](https://github.com/shipshapecode/vue-shepherd)\n#### [Ember Shepherd Wrapper](https://github.com/RobbieTheWagner/ember-shepherd)\n\n### Commercial license\n\nIf 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)\n\n# White Glove Services\n\nIf 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:ahoy@shipshape.io)! \n\n\n## Resources\n\n- [Website](https://shepherdjs.dev/)\n- [Documentation](https://docs.shepherdjs.dev/)\n- [Demo](https://shepherdjs.dev/)\n- [Discord](https://discord.gg/EGcDW5NSud)\n\n\n## Contributing\n\nWe encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md).\nOur release process is mostly automated. For more details, see [RELEASE.md](RELEASE.md).\n\n\n## Projects Already Using Shepherd\n\n### [SimplePlanner](https://simpleplanner.io)\n\n[SimplePlanner](https://simpleplanner.io) uses Shepherd to help new users get familiar with its collaborative scheduling approach. \nYou do need to sign up via OAuth or email to see the scheduling tour. \nCheck 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.\n\n### [LogSeq](https://logseq.com/) \n\n[LogSeq](https://logseq.com/) uses Shepherd to guide users through initial setup steps.\n\n### [Snapsure](https://snapsure.app)\n\n[Snapsure](https://snapsure.app) uses Shepherd to help photographers learn how to set up alerts for their desired picture-perfect weather conditions.\n\n### [Drupal](https://www.drupal.org/docs/8/core/modules/tour/overview)\n\nThe [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.\n\n### [Budibase Shepherd Tour Plugin](https://github.com/JayP718/tour_shepherd_bb_plugin)\n\n[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.\n\n\n### Your Project Here\n\nIf you have a cool open-source library built on Shepherd, PR this doc.\n\n\n## License\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fshipshapecode%2Fshepherd.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fshipshapecode%2Fshepherd?ref=badge_large)\n","funding_links":["https://github.com/sponsors/rwwagner90"],"categories":["JavaScript","CSS","Tool Collection","hacktoberfest","Helper Components"],"sub_categories":["Search"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipshapecode%2Fshepherd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshipshapecode%2Fshepherd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipshapecode%2Fshepherd/lists"}