{"id":18322757,"url":"https://github.com/labs64/guidechimp","last_synced_at":"2025-04-05T12:03:50.372Z","repository":{"id":3548115,"uuid":"4608586","full_name":"Labs64/GuideChimp","owner":"Labs64","description":"Create interactive guided product tours in minutes with the most non-technical friendly, lightweight and extendable library.","archived":false,"fork":false,"pushed_at":"2023-12-14T12:22:05.000Z","size":11546,"stargazers_count":191,"open_issues_count":14,"forks_count":20,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-05-15T17:12:23.841Z","etag":null,"topics":["beacon","employee-training","feature-adoption","flow","guide","guided-tour","hacktoberfest","hint","hotspot","onboarding","product-tour","tooltips","tour","tour-guide","tour-guide-app","tours","user-experience","user-flow","walkthrough"],"latest_commit_sha":null,"homepage":"https://www.labs64.com/guidechimp/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"eupl-1.2","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Labs64.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"custom":"https://www.paypal.me/labs64"}},"created_at":"2012-06-09T16:24:27.000Z","updated_at":"2024-05-09T13:09:05.000Z","dependencies_parsed_at":"2024-01-13T14:35:42.215Z","dependency_job_id":null,"html_url":"https://github.com/Labs64/GuideChimp","commit_stats":{"total_commits":685,"total_committers":10,"mean_commits":68.5,"dds":0.5518248175182482,"last_synced_commit":"b443311adfb767f326a77186173221dc03e27189"},"previous_names":[],"tags_count":97,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Labs64%2FGuideChimp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Labs64%2FGuideChimp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Labs64%2FGuideChimp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Labs64%2FGuideChimp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Labs64","download_url":"https://codeload.github.com/Labs64/GuideChimp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332560,"owners_count":20921853,"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":["beacon","employee-training","feature-adoption","flow","guide","guided-tour","hacktoberfest","hint","hotspot","onboarding","product-tour","tooltips","tour","tour-guide","tour-guide-app","tours","user-experience","user-flow","walkthrough"],"created_at":"2024-11-05T18:25:52.877Z","updated_at":"2025-04-05T12:03:50.353Z","avatar_url":"https://github.com/Labs64.png","language":"JavaScript","funding_links":["https://www.paypal.me/labs64"],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://www.labs64.com/guidechimp/\"\u003e\u003cp align=\"center\"\u003e\u003cimg src=\"https://io.labs64.com/GuideChimp/docs/img/guidechimp-logo-transparent.png\" alt=\"GuideChimp - Logo\"\u003e\u003c/p\u003e\u003c/a\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/Labs64/GuideChimp/actions?query=workflow%3A%22GuideChimp+CI%22\"\u003e\u003cimg src=\"https://github.com/Labs64/GuideChimp/workflows/GuideChimp%20CI/badge.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e\n\u003ca href=\"https://badge.fury.io/js/guidechimp\"\u003e\u003cimg src=\"https://badge.fury.io/js/guidechimp.svg\" alt=\"GuideChimp @ npmjs\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.jsdelivr.com/package/npm/guidechimp\"\u003e\u003cimg src=\"https://data.jsdelivr.com/v1/package/npm/guidechimp/badge\" alt=\"GuideChimp @ jsDelivr\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Labs64/GuideChimp/blob/master/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-EUPL--1.2-blue.svg\" alt=\"European Union Public License, version 1.2\"\u003e\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://github.com/Labs64/GuideChimp/wiki/Plugins\"\u003e\u003cimg src=\"https://img.shields.io/badge/Plugins-12-AB6543.svg\" alt=\"GuideChimp Plugins\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Labs64/GuideChimp/wiki\"\u003e\u003cimg src=\"https://img.shields.io/badge/📖%20Documentation-Wiki-AB6543.svg\" alt=\"📖 Documentation\"\u003e\u003c/a\u003e\n\u003ca href=\"https://chrome.google.com/webstore/detail/guidechimp-chrome-extensi/afecedbgkfoijeligfjflidfddndnjng\"\u003e\u003cimg src=\"https://img.shields.io/badge/🌐%20Chrome%20Extension-FFCD46.svg\" alt=\"GuideChimp @ Chrome Extension\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.labs64.com/guidechimp/\"\u003e\u003cimg src=\"https://img.shields.io/badge/🌐%20GuideChimp-Website-AB6543.svg\" alt=\"🌐 GuideChimp Website\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.linkedin.com/showcase/guidechimp\"\u003e\u003cimg src=\"https://img.shields.io/badge/GuideChimp-0077B5.svg?logo=LinkedIn\" alt=\"GuideChimp @ LinkedIn\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\nDeliver the perfect product experience, improve digital product adoption, boost adoption of new features and simplify user onboarding with step by step interactive walkthroughs.\n\n# What can you do with GuideChimp?\n\n\u003ca href=\"https://www.labs64.com/guidechimp/\"\u003e\u003cp align=\"center\"\u003e\u003cimg src=\"https://io.labs64.com/GuideChimp/docs/img/guidechimp-stage-04-shadow.png\"  alt=\"GuideChimp - Where To Use\"\u003e\u003c/p\u003e\u003c/a\u003e\n\n- \u003cstrong\u003eUser Experience:\u003c/strong\u003e Implement engaging and personalised guides to walk users through your system.\n- \u003cstrong\u003eUser Onboarding:\u003c/strong\u003e Successfully onboard your users from day one with an intuitive step by step walkthroughs.\n- \u003cstrong\u003eFeature Adoption:\u003c/strong\u003e Introduce and highlight new features with personalized guides.\n- \u003cstrong\u003eIn-product Messaging:\u003c/strong\u003e Engage the right segment of your users at the right time and increase conversion.\n- \u003cstrong\u003eEmployee Training:\u003c/strong\u003e Improve your employees' productivity by providing an efficient and interactive training system.\n\nThe world's smartest companies using our GuideChimp to boost their user experience.\n\n# Features\n\n- Seamless integration with any web app.\n- Start guided tour on any website with [GuideChimp Chrome Extension](https://chrome.google.com/webstore/detail/guidechimp-chrome-extensi/afecedbgkfoijeligfjflidfddndnjng) and... ZERO! code.\n- GuideChimp is simple and robust enough to provide results with minimal effort! Set up it in just 3 minutes!\n- Let GuideChimp look like an integral part of your software product by configuring its look \u0026 feel\n- GuideChimp works well with tools you already use (e.g. WordPress, Confluence, etc.).\n- [Beacons](https://github.com/Labs64/GuideChimp/wiki/Beacons-plugin) 🟠 Hotspots 🟠 Hints: Raise visitors attention by adding an additional description to any element on the web page.\n- Tours: Flows, Walkthroughs, Guides, Tutorials\n- Support of *Single Page Applications* build with Angular, Vue.js, React, etc.\n- Extendable using out-of-the-box and third-party [plugins](https://github.com/Labs64/GuideChimp/wiki/Plugins)\n- Dynamic [placeholders](https://github.com/Labs64/GuideChimp/wiki/Placeholders-plugin) in the tour definition\n- Detailed installation and configuration [documentation](https://github.com/Labs64/GuideChimp/wiki)\n- Tooltip auto-positioning on an element\n- Easy styling through SCSS and clean CSS\n- Tour steps can be defined in two ways: HTML elements data attributes and JavaScript object properties\n- Library installation possible through HTML and es6 import\n- Use multiple listeners on tour events\n- Internationalization / i18n [support](https://github.com/Labs64/GuideChimp/wiki/Examples)\n- Ability to add steps on-the-fly / programmatically\n- Enable tour on the lazy-loaded or delayed elements (post-rendering, route changing, etc.) in single-page applications using \"onBeforeChange\" event or [Lazy-loading plugin](https://github.com/Labs64/GuideChimp/wiki/Lazy-loading-plugin)\n- Ability to define custom action buttons\n- Flexibility and modularity; GuideChimp is designed as a JS class, so you can easily inherit from it and change / add custom methods\n- Improved usability - pagination, navigation and progress bar\n- HTML code can be also used in the tooltip text\n- Support of extra-large tooltip description texts\n- Ability to set callback (\"onBeforeChange\", \"onAfterChange\") functions for each step in the tour\n- Lightweight (*\u003c 45KB*) and good performance\n- **Last But Not Least:** :point_up: Dual-Licensed - [EUPL-1.2](LICENSE) and [Commercial](https://www.labs64.com/guidechimp/#guidechimp-licensing) (including great support, maintenance and customized implementation)\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://io.labs64.com/GuideChimp/docs/img/netlicensing-features-tour.gif\"  alt=\"Labs64 NetLicensing - Features Tour\"\u003e\u003c/p\u003e\n\n\n# 📖 Documentation\n\nVisit GuideChimp [Wiki](https://github.com/Labs64/GuideChimp/wiki) for installation and configuration tips, customizations and plugins, as well as [examples](https://github.com/Labs64/GuideChimp/wiki/Examples) on how to use GuideChimp in the real-world scenarios.\n\n\n# How to Use\n\nIn order to use GuideChimp, you must include the compiled and minified JavaScript file in your project. There are multiple options for including these pre-compiled files, also known as a distribution, in your website or application.\n\n\n## 1) Using from a CDN\n\n- jsDelivr - https://www.jsdelivr.com/package/npm/guidechimp\n\n\n## 2) Install as Node.js/npm Module\n\nGuideChimp is available on [npmjs](https://www.npmjs.com/package/guidechimp). Add the following to your `package.json` file and then run `npm install`:\n```json\n\"dependencies\": {\n    \"guidechimp\": \"x.y.z\"\n}\n```\n\nor execute following command in your Node.js environment:\n\n```bash\n$ npm install guidechimp\n```\n\n## 3) Install as ES6 Module\n\nIf you are using ES6 modules, import the library and CSS file:\n\n```javascript\nimport GuideChimp from 'guidechimp';\nimport 'guidechimp/dist/guidechimp.min.css';\n```\n\n## 4) Manual Installation\n\nWe strongly recommend that you use either a CDN or a package manager like npm. This will make it easier for you to deploy your project in different environments, and easily update GuideChimp when new versions are released. Nonetheless, if you prefer to integrate GuideChimp into your project manually, you can [download the release of your choice](https://github.com/Labs64/guidechimp/releases) from GitHub and copy the files from the `dist` directory into your project.\n\nInclude the compiled files in your HTML page:\n```html\n\u003cscript src=\"guidechimp/dist/guidechimp.min.js\"\u003e\u003c/script\u003e\n\u003clink rel=\"stylesheet\" href=\"guidechimp/dist/guidechimp.min.css\"\u003e\n```\n\n\n# Demo\n\nSee GuideChimp in action in the product walkthrough, showcases and real-world examples below:\n\n- [GuideChimp Tour Examples](https://codepen.io/collection/DyPkzY) at CodePen\n- [NetLicensing Changelog](https://netlicensing.io/wiki/changelog) - Tour: Notable NetLicensing Features\n- [NetLicensing Licensing Models](https://netlicensing.io/licensing-models/?guidechimp=on\u0026tour=licensing-models) - Sample Tour: Licensing Models\n- [NetLicensing Features](https://netlicensing.io/features/?guidechimp=on\u0026tour=features) - Sample Tour: NetLicensing Features\n- [NetLicensing Onboarding](https://ui.netlicensing.io/#/login?cr=ZGVtbzpkZW1v\u0026utm_source=GitHub\u0026utm_medium=website\u0026utm_campaign=GuideChimp_demo\u0026utm_content=demo) - NetLicensing UI: User Onboarding Tour\n- [React Example](https://209hg.csb.app) ([source](https://codesandbox.io/s/guidechimp-react-example-209hg)) at CodeSandbox by [@giubatt](https://github.com/giubatt)\n\n\n# How to Contribute\n\nEveryone is welcome to contribute to this project!\nFeel free to [contribute](CONTRIBUTING.md) with pull requests, bug reports or enhancement suggestions.\n\n---\n\nGuideChimp is maintained by Labs64.\n[Contact](https://www.labs64.com/contact/) us for web app consulting, development, and training for your project or book a demo.\n\n---\n\n\u003ca href=\"https://www.producthunt.com/posts/guidechimp?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-guidechimp\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=182973\u0026theme=light\" alt=\"GuideChimp - Simplify user onboarding with interactive walkthroughs | Product Hunt Embed\" style=\"width: 250px; height: 54px;\" width=\"250px\" height=\"54px\" /\u003e\u003c/a\u003e\n\n\n# Bugs and Feedback\n\nFor bugs, questions and discussions please use the [GitHub Issues](https://github.com/Labs64/guidechimp/issues).\n\n\n# License\n\nGuideChimp is made available under the [European Union Public License, version 1.2](LICENSE) or [Commercial License](https://www.labs64.com/guidechimp/#guidechimp-licensing).\nThe Commercial License requires the payment of a fee for each designated commercial application.\n- If you choose not to pay a fee and use the *European Union Public License, version 1.2*, you are required to release the source code of any program that you distribute that uses GuideChimp.\n- If you choose to pay for a *Commercial License*, you are not required to disclose your source code.\n\nCommercial GuideChimp plugins require a [valid customer account](https://www.labs64.com/guidechimp/#guidechimp-licensing) with the assigned plan and [additional configuration](https://github.com/Labs64/GuideChimp/wiki/Licensing-plugin), which will be used to validate the availability of particular GuideChimp functions or plugins for the given customer account.\n\n# Privacy Policy\n\nThe applicable data protection provisions may be retrieved under [Privacy Policy](privacy-policy.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flabs64%2Fguidechimp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flabs64%2Fguidechimp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flabs64%2Fguidechimp/lists"}