{"id":21189229,"url":"https://github.com/uptick/react-interactive-tutorials","last_synced_at":"2025-07-10T02:31:43.196Z","repository":{"id":46764882,"uuid":"60816456","full_name":"uptick/react-interactive-tutorials","owner":"uptick","description":"Framework for creating unobtrusive interactive tutorials for use in web apps.","archived":false,"fork":false,"pushed_at":"2021-09-24T17:48:03.000Z","size":464,"stargazers_count":40,"open_issues_count":6,"forks_count":7,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-11-11T21:57:41.566Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uptick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-10T00:55:56.000Z","updated_at":"2024-07-24T08:55:18.000Z","dependencies_parsed_at":"2022-09-14T22:54:47.019Z","dependency_job_id":null,"html_url":"https://github.com/uptick/react-interactive-tutorials","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Freact-interactive-tutorials","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Freact-interactive-tutorials/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Freact-interactive-tutorials/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptick%2Freact-interactive-tutorials/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uptick","download_url":"https://codeload.github.com/uptick/react-interactive-tutorials/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225614988,"owners_count":17496938,"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":[],"created_at":"2024-11-20T18:50:50.390Z","updated_at":"2024-11-20T18:50:51.202Z","avatar_url":"https://github.com/uptick.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-interactive-tutorials\n\n[![npm version](https://badge.fury.io/js/react-interactive-tutorials.svg)](http://badge.fury.io/js/react-interactive-tutorials)\n![Downloads](http://img.shields.io/npm/dm/react-interactive-tutorials.svg?style=flat)\n\nFramework for creating unobtrusive interactive tutorials for use in web apps.\n\n## Live Demo\n\nHave a play around with the live demo here: http://uptick.github.io/react-interactive-tutorials/\n\n## How it Works\n\nTutorials are represented as a set of prompts that will result in the user successfully completing\nactions within the interface of your app.\n\nRather than storing a state of the current tutorial step, the currently active tutorial step is\ncalculated on the fly by the step configuration's set of conditions. This allows the user to go off\nand do something unexpected / get lost in the middle of a tutorial without consequence.\n\n## Requirements\n\nTo install, you will need:\n\n- Bootstrap 4 stylesheet, or an implementation of the used classes:\n  - btn\n  - btn-primary\n  - btn-secondary\n  - float-right\n\nAnd anyone using your site will need:\n\n- A relatively modern browser\n- Javascript enabled\n- Cookies enabled\n\n## Installation\n\nInstall the npm package:\n\n```\nnpm install react-interactive-tutorials\n```\n\nInclude the built css located at:\n\n```\nnode_modules/react-interactive-tutorials/dist/react-interactive-tutorials.css\n```\n\nRegister your own tutorials:\n\n```javascript\n// es6\nimport { registerTutorials } from 'react-interactive-tutorials'\nregisterTutorials(YOUR_TUTORIALS);\n\n// attached to global var\ninteractiveTutorials.registerTutorials(YOUR_TUTORIALS);\n```\n\n## Making tutorials\n\nFull reference documentation coming soon. For now, take a look at the reference on the live demo at\nhttp://uptick.github.io/react-interactive-tutorials/.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Freact-interactive-tutorials","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuptick%2Freact-interactive-tutorials","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptick%2Freact-interactive-tutorials/lists"}