{"id":18484880,"url":"https://github.com/prscx/react-native-app-tour","last_synced_at":"2025-10-22T02:55:48.240Z","repository":{"id":30547311,"uuid":"125322748","full_name":"prscX/react-native-app-tour","owner":"prscX","description":"React Native: Native App Tour Library","archived":false,"fork":false,"pushed_at":"2025-02-24T08:17:36.000Z","size":2543,"stargazers_count":643,"open_issues_count":31,"forks_count":118,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-10-02T11:47:37.519Z","etag":null,"topics":["android","ios","react-native"],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prscX.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-15T06:30:29.000Z","updated_at":"2025-09-26T16:48:07.000Z","dependencies_parsed_at":"2024-01-13T17:12:34.214Z","dependency_job_id":"99a09607-c215-48a1-91b1-71c271e0be98","html_url":"https://github.com/prscX/react-native-app-tour","commit_stats":{"total_commits":126,"total_committers":17,"mean_commits":7.411764705882353,"dds":0.5,"last_synced_commit":"a88bfd09053ecd9c7709e5a62340b4bbd9e66247"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/prscX/react-native-app-tour","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prscX%2Freact-native-app-tour","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prscX%2Freact-native-app-tour/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prscX%2Freact-native-app-tour/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prscX%2Freact-native-app-tour/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prscX","download_url":"https://codeload.github.com/prscX/react-native-app-tour/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prscX%2Freact-native-app-tour/sbom","scorecard":{"id":747562,"data":{"date":"2025-08-11","repo":{"name":"github.com/prscX/react-native-app-tour","commit":"2d6819df0295cea5d4c1b03d6fc75364981d242b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":3,"reason":"Found 6/19 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: Example/android/gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.0.5 not signed: https://api.github.com/repos/prscX/react-native-app-tour/releases/45272591","Warn: release artifact v0.0.19 not signed: https://api.github.com/repos/prscX/react-native-app-tour/releases/16459606","Warn: release artifact v1.0.5 does not have provenance: https://api.github.com/repos/prscX/react-native-app-tour/releases/45272591","Warn: release artifact v0.0.19 does not have provenance: https://api.github.com/repos/prscX/react-native-app-tour/releases/16459606"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 17 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T19:16:37.656Z","repository_id":30547311,"created_at":"2025-08-22T19:16:37.657Z","updated_at":"2025-08-22T19:16:37.657Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280370896,"owners_count":26319317,"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","status":"online","status_checked_at":"2025-10-22T02:00:06.515Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["android","ios","react-native"],"created_at":"2024-11-06T12:43:27.511Z","updated_at":"2025-10-22T02:55:48.214Z","avatar_url":"https://github.com/prscX.png","language":"Objective-C","funding_links":["https://www.buymeacoffee.com/prscX"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.npmjs.com/package/react-native-app-tour\"\u003e\u003cimg src=\"http://img.shields.io/npm/v/react-native-app-tour.svg?style=flat\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/prscX/react-native-app-tour/pulls\"\u003e\u003cimg alt=\"PRs Welcome\" src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/prscX/react-native-app-tour#License\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/react-native-app-tour.svg?style=flat\" /\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\n    ReactNative: Native App Tour Library (Android/iOS)\n\nIf this project has helped you out, please support us with a star 🌟\n\n\u003c/h1\u003e\n\nThis library is a React Native bridge around native app tour libraries. It allows show/guide beautiful tours:\n\n| **Android: [KeepSafe/TapTargetView](https://github.com/KeepSafe/TapTargetView)**                              |\n| ------------------------------------------------------------------------------------------------------------- |\n| \u003cimg src=\"https://github.com/KeepSafe/TapTargetView/raw/master/.github/video.gif\" width=\"300\" height=\"600\" /\u003e |\n\n| **iOS: [aromajoin/material-showcase-ios](https://github.com/aromajoin/material-showcase-ios)**                                 |\n| ------------------------------------------------------------------------------------------------------------------------------ |\n| \u003cimg src=\"https://github.com/aromajoin/material-showcase-ios/raw/master/art/material-showcase.gif\" width=\"300\" height=\"600\" /\u003e |\n\n## 📖 Getting started\n\n`$ npm install react-native-app-tour --save`\n\n\u003e Supported react-native 61 and above\n\n- **iOS**\n\n\u003e **iOS Prerequisite:** Please make sure `CocoaPods` is installed on your system\n\n    - Add the following to your `Podfile` -\u003e `ios/Podfile` and run pod update:\n\n```\n  use_native_modules!\n\n  pod 'RNAppTour', :path =\u003e '../node_modules/react-native-app-tour/ios'\n\n  use_frameworks! :linkage =\u003e :static\n\n  pod 'MaterialShowcase'\n\n  # Follow [Flipper iOS Setup Guidelines](https://fbflipper.com/docs/getting-started/ios-native)\n  # This is required because iOSPhotoEditor is implemented using Swift and we have to use use_frameworks! in Podfile\n  $static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',\n    'CocoaAsyncSocket', 'ComponentKit', 'Flipper-DoubleConversion',\n    'Flipper-Glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',\n    'CocoaLibEvent', 'OpenSSL-Universal', 'boost-for-react-native']\n\n  pre_install do |installer|\n    Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}\n    installer.pod_targets.each do |pod|\n        if $static_framework.include?(pod.name)\n          def pod.build_type;\n            Pod::BuildType.static_library\n          end\n        end\n      end\n  end\n\n```\n\n- Please make sure [**Flipper iOS Setup Guidelines**](https://fbflipper.com/docs/getting-started/ios-native/) steps are added to Podfile, since MaterialShowcase is implemented using Swift and we have to use use_frameworks! in Podfile\n\n- **Android**\n\nPlease add below snippet into your app `build.gradle`\n\n```\nallprojects {\n    repositories {\n        maven { url 'https://jitpack.io' }\n    }\n}\n```\n\n## 💬 ISSUES\n\n- If you install this package and get an error saying postinstall failed this most likely means\n  - You are trying to run install modules from outside of project root (react-native-git-upgrade)\n    - FIX: remove react-native-app-tour from package.json and rerun\n  - Pods version is out of date.\n    - `pod repo update`\n- If you encounter `File not found in iOS` issue while setup, please refer [ISSUE - 3](https://github.com/prscX/react-native-app-tour/issues/3) issue which might help you in order to resolve.\n- If you have problems with `Android` Trying to resolve view with tag which doesn't exist or can't resolve tag. Please add props `collapasable: false` to your View\n\n## 🎨 API's\n\n- AppTourView.for: AppTourTarget\n\n```\nlet appTourTarget = AppTourView.for(Button, {...native-library-props})\n\nAppTour.ShowFor(appTourTarget)\n```\n\n- AppTourSequence\n  - add(AppTourTarget)\n  - remove(AppTourTarget)\n  - removeAll\n  - get(AppTourTarget)\n  - getAll\n\n```\nlet appTourSequence = new AppTourSequence()\nthis.appTourTargets.forEach(appTourTarget =\u003e {\nappTourSequence.add(appTourTarget)\n})\n\nAppTour.ShowSequence(appTourSequence)\n```\n\n- AppTour\n  - ShowFor(AppTourTarget)\n  - ShowSequence(AppTourTargets)\n\n## 💡 Props\n\n\u003e **Note:**\n\u003e\n\u003e - Each component which is to be rendered in the tour should have a `key` prop. It is mandatory.\n\u003e - App Tour Target Properties are same as defined by [KeepSafe/TapTargetView](https://github.com/KeepSafe/TapTargetView) \u0026 [aromajoin/material-showcase-ios](https://github.com/aromajoin/material-showcase-ios)\n\n- **General(iOS \u0026 Android)**\n\n| Prop                   | Type                | Default | Note                                             |\n| ---------------------- | ------------------- | ------- | ------------------------------------------------ |\n| `order: mandatory`     | `number`            |         | Specify the order of tour target                 |\n| `title`                | `string`            |         | Specify the title of tour                        |\n| `description`          | `string`            |         | Specify the description of tour                  |\n| `outerCircleColor`     | `string: HEX-COLOR` |         | Specify a color for the outer circle             |\n| `targetCircleColor`    | `string: HEX-COLOR` |         | Specify a color for the target circle            |\n| `titleTextSize`        | `number`            | 20      | Specify the size (in sp) of the title text       |\n| `titleTextColor`       | `string: HEX-COLOR` |         | Specify the color of the title text              |\n| `descriptionTextSize`  | `number`            | 10      | Specify the size (in sp) of the description text |\n| `descriptionTextColor` | `string: HEX-COLOR` |         | Specify the color of the description text        |\n| `targetRadius`         | `number`            | 60      | Specify the target radius (in dp)                |\n| `cancelable`           | `bool`              | true    | Whether tapping anywhere dismisses the view      |\n\n- **Android**\n\n| Prop                     | Type                | Default | Note                                                                                                                                                                           |\n| ------------------------ | ------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `collapsable: mandatory` | `bool`              |         | Specify collapsable `false` if your view just contains children. Please read [view#collapsable](https://facebook.github.io/react-native/docs/view#collapsable) for the details |\n| `outerCircleAlpha`       | `number`            | 0.96f   | Specify the alpha amount for the outer circle                                                                                                                                  |\n| `textColor`              | `string: HEX-COLOR` |         | Specify a color for both the title and description text                                                                                                                        |\n| `dimColor`               | `string: HEX-COLOR` |         | If set, will dim behind the view with 30% opacity of the given color                                                                                                           |\n| `drawShadow`             | `bool`              | true    | Whether to draw a drop shadow or not                                                                                                                                           |\n| `tintTarget`             | `bool`              | true    | Whether to tint the target view's color                                                                                                                                        |\n| `transparentTarget`      | `bool`              | true    | Specify whether the target is transparent (displays the content underneath)                                                                                                    |\n\n- **iOS**\n\n| Prop                         | Type                | Default      | Note                                                       |\n| ---------------------------- | ------------------- | ------------ | ---------------------------------------------------------- |\n| `backgroundPromptColor`      | `string: HEX-COLOR` | UIColor.blue | Specify background prompt color                            |\n| `backgroundPromptColorAlpha` | `number`            | 0.96         | Specify background prompt color alpha                      |\n| `titleTextAlignment`         | `string`            | left         | Specify primary text alignment: Left, Right, Top, Bottom   |\n| `descriptionTextAlignment`   | `string`            | left         | Specify secondary text alignment: Left, Right, Top, Bottom |\n| `aniComeInDuration`          | `number`            | 0.5          | Specify animation come In Duration                         |\n| `aniGoOutDuration`           | `number`            | 1.5          | Specify animation Go Out Duration                          |\n| `aniRippleColor`             | `string: HEX-COLOR` | #FFFFFF      | Specify ripple color                                       |\n| `aniRippleAlpha`             | `number`            | 0.2          | Specify ripple alpha                                       |\n\n## 🔧 Breaking Changes\n\n- [V0.0.4](https://github.com/prscX/react-native-app-tour/releases/tag/v0.0.4)\n\n  - Generalized props across platforms @congnguyen91\n  - Migrated License to Apache 2.0\n\n- [V0.0.10](https://github.com/prscX/react-native-app-tour/releases/tag/v0.0.10)\n  - Added `order` as a mandatory property to each target\n  - Each component which is to be rendered in the tour should have a `key` prop. It is mandatory.\n\n## ✨ Credits\n\n- Android: [KeepSafe/TapTargetView](https://github.com/KeepSafe/TapTargetView)\n- iOS: [aromajoin/material-showcase-ios](https://github.com/aromajoin/material-showcase-ios)\n\n## 🤔 How to contribute\n\nHave an idea? Found a bug? Please raise to [ISSUES](https://github.com/prscX/react-native-app-tour/issues).\nContributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.\n\n## 💫 Where is this library used?\n\nIf you are using this library in one of your projects, add it in this list below. ✨\n\n## 📜 License\n\nThis library is provided under the Apache 2 License.\n\nRNAppTour @ [prscX](https://github.com/prscX)\n\n## 💖 Support my projects\n\nI open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).\n\nHowever, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:\n\n- Starring and sharing the projects you like 🚀\n- If you're feeling especially charitable, please follow [prscX](https://github.com/prscX) on GitHub.\n\n  \u003ca href=\"https://www.buymeacoffee.com/prscX\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: auto !important;width: auto !important;\" \u003e\u003c/a\u003e\n\n  Thanks! ❤️\n  \u003cbr/\u003e\n  [prscX.github.io](https://prscx.github.io)\n  \u003cbr/\u003e\n  \u003c/ Pranav \u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprscx%2Freact-native-app-tour","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprscx%2Freact-native-app-tour","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprscx%2Freact-native-app-tour/lists"}