{"analyzedAt":"2022-12-22T03:31:07.099Z","collected":{"metadata":{"name":"blinkid-react-native","scope":"unscoped","version":"5.17.0","description":"A small and powerful ID card scanning library. Powered by Microblink (www.microblink.com).","keywords":["scan","id","scanner","identity","ID","passport","licence","sdk","ocr","USDL","PDF417","MRZ","MRTD","barcode","DL","card","document","microblink","react-native","blinkid","ID","ios","android"],"date":"2022-06-30T07:14:40.117Z","author":{"name":"Microblink"},"publisher":{"username":"mgracanin","email":"mijo.gracanin@gmail.com"},"maintainers":[{"username":"ivancuric","email":"ivan.curic@gmail.com"},{"username":"mirzamesic","email":"mesic.mirza07@gmail.com"},{"username":"dodoent","email":"DoDoEntertainment@gmail.com"},{"username":"markosopcic","email":"marko.sopcic@microblink.com"},{"username":"microblinkadmin","email":"info@microblink.com"},{"username":"juraskrlec","email":"jura.skrlec@microblink.com"},{"username":"igrce","email":"ivan.grce@microblink.com"},{"username":"matvidako_micro","email":"matej.vidakovic@microblink.com"},{"username":"stepanic","email":"stepanic@loopus.co"},{"username":"vjekoart","email":"vjekoart@gmail.com"},{"username":"dcubelic-mb","email":"dominik.cubelic@microblink.com"},{"username":"mgracanin","email":"mijo.gracanin@gmail.com"},{"username":"matijakrizanec","email":"matija.krizanec@microblink.com"}],"repository":{"type":"git","url":"git+https://github.com/BlinkID/blinkid-react-native.git"},"links":{"npm":"https://www.npmjs.com/package/blinkid-react-native","homepage":"https://github.com/BlinkID/blinkid-react-native","repository":"https://github.com/BlinkID/blinkid-react-native","bugs":"https://github.com/BlinkID/blinkid-react-native/issues"},"license":"MIT","releases":[{"from":"2022-11-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":1},{"from":"2022-09-23T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":1},{"from":"2022-06-25T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":2},{"from":"2021-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":5},{"from":"2020-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":10}],"readme":"# BlinkID SDK wrapper for React Native\n\nBest-in-class ID scanning software for cross-platform apps built with React Native.\n\nBelow, you’ll find a quick guide on starting your own demo project as well as complete guidance on installing and linking BlinkID library with your iOS and Android apps ⬇️\n\nFor a full access to all features and functionalities, please consider using our native SDKs (for [iOS](https://github.com/BlinkID/blinkid-ios) or [Android](https://github.com/BlinkID/blinkid-android))\n\n\n## Licensing\n\n- A valid license key is required to initialize scanning. You can request a **free trial license key**, after you register, at [Microblink Developer Hub](https://account.microblink.com/signin)\n\n- For production licensing, please [contact sales](https://microblink.com/contact-us) to request a quote.\n\n**Keep in mind:** Versions 5.8.0 and above require an internet connection to work under our new License Management Program.\n\nWe’re only asking you to do this so we can validate your trial license key. Scanning or data extraction of identity documents still happens offline, on the device itself. \n\nOnce the validation is complete, you can continue using the SDK in offline mode (or over a private network) until the next check.\n\n\n## React Native Version\n\nBlinkID React Native was built and tested with [React Native v0.64.0](https://github.com/facebook/react-native/releases/tag/v0.64.0)\n\n## Installation\n\nFirst generate an empty project if needed:\n\n```shell\nreact-native init --version=\"0.64.0\" NameOfYourProject\n```\n\nAdd the **blinkid-react-native** module to your project:\n\n```shell\ncd \nnpm i --save blinkid-react-native\n```\n\n## Linking\n\n### iOS\n\nLink module with your project: \n\n```shell\nreact-native link blinkid-react-native\n```\n\n[CocoaPods](http://cocoapods.org) is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like BlinkID in your projects.\n\n- If you wish to use version v1.4.0 or above, you need to install [Git Large File Storage](https://git-lfs.github.com) by running these comamnds:\n\n```shell\nbrew install git-lfs\ngit lfs install\n```\n\n- **Be sure to restart your console after installing Git LFS**\n\n#### Installing pods\n\nFrom [react-native 0.60](https://facebook.github.io/react-native/blog/2019/07/03/version-60#cocoapods-by-default) CocoaPods are now part of React Native's iOS project.\n\nGo to `NameOfYourProject/ios` folder and install Pods\n\n```shell\npod install\n```\n\nOur `blinkid-react-native` depends on latest `PPBlinkID` pod so it will be installed automatically.\n\n**To run iOS application, open NameOfYourProject.xcworkspace, set Your team for every Target in General settings and add Privacy - Camera Usage Description key to Your info.plist file and press run**\n\n### Android\n\nAdd microblink maven repository to project level build.gradle:\n\n```\nallprojects {\n repositories {\n // don't forget to add maven and jcenter\n mavenLocal()\n jcenter()\n \n // ... other repositories your project needs\n \n maven { url \"http://maven.microblink.com\" }\n }\n}\n```\n\n## Sample\n\nThis repository contains **initReactNativeSampleApp.sh** script that will create React Native project and download all of its dependencies. You can run this script with following command: \n```shell\n./initReactNativeSampleApp.sh\n```\n\n## Video tutorial\n\nStep by step guide how to start blinkid-reactnative sample app. A tutorial flows from cloning repository via git clone to successfully deployed sample application on Android and iOS device with real-time screen mirroring. Application sample contains the simple use of USDL recognizer with Ontario drivers license card.\n\n

\n \n \"Video\n \n Watch on Vimeo\n

\n\n ### Using documentVerificationOverlay and CombinedRecognizer\n\nThis video tutorial describes how to use documentVerificationOverlay with UsdlCombinedRecognizer.\nDocumentVerificationOverlay is overlay for RecognizerRunnerFragment best suited for combined recognizers because it manages scanning of multiple document sides in the single camera opening and guides the user through the scanning process. It can also be used for single side scanning of ID cards, passports, driver’s licenses, etc\n\n

\n \n \"Video\n \n Watch on Vimeo\n

\n\n## Usage\n\nTo use the module you call it in your index.android.js or index.ios.js file like in the [sample app](SampleFiles/index.js). Available recognizers and API documentation is available in [JS API files](BlinkID).\n\n## FAQ\n\n**Can I create a custom UI overlay?**\n\nYes you can, but you will have to implement it natively for android and ios, you can see native implementation guides [here(Android)](https://github.com/BlinkID/blinkid-android#recognizerRunnerView) and [here(ios)](https://github.com/BlinkID/blinkid-ios#recognizerRunnerViewController).\n\n## Known react-native problems:\n\n### iOS\nReact native v0.62.2\n\n** [NSURLResponse allHeaderFields]: unrecognized selector sent to instance**\n\nMake sure to use the Flipper version 0.37.0 in your Podfile:\n\n`versions['Flipper'] ||= '~> 0.37.0'` \n\n### Android build exception - missing `ReactSwipeRefreshLayout`\n\n**java.lang.NoClassDefFoundError: com.facebook.react.views.swiperefresh.ReactSwipeRefreshLayout**\n\nAdd the following line to dependencies section in android/app/build.gradle:\n\n`implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0-alpha02'`"},"npm":{"downloads":[{"from":"2022-12-21T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-12-15T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":1482},{"from":"2022-11-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":8974},{"from":"2022-09-23T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":28308},{"from":"2022-06-25T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":59994},{"from":"2021-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":126051}],"starsCount":0},"github":{"starsCount":162,"forksCount":54,"subscribersCount":25,"issues":{"count":203,"openCount":29,"distribution":{"3600":51,"10800":12,"32400":3,"97200":15,"291600":10,"874800":15,"2624400":13,"7873200":16,"23619600":12,"70858800":40,"212576400":16},"isDisabled":false},"contributors":[{"username":"i1E","commitsCount":107},{"username":"juraskrlec","commitsCount":76},{"username":"DoDoENT","commitsCount":31},{"username":"matvidako","commitsCount":12},{"username":"mvayngrib","commitsCount":6},{"username":"culoi","commitsCount":6},{"username":"mijo-gracanin","commitsCount":6},{"username":"Minishlink","commitsCount":5},{"username":"ceyhun","commitsCount":4},{"username":"Cerovec","commitsCount":3},{"username":"busakj","commitsCount":2},{"username":"devfubar","commitsCount":1},{"username":"dinogustinn","commitsCount":1},{"username":"iBotPeaches","commitsCount":1},{"username":"tonikreso","commitsCount":1}],"commits":[{"from":"2022-12-15T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-11-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-09-23T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":0},{"from":"2022-06-25T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":3},{"from":"2021-12-22T00:00:00.000Z","to":"2022-12-22T00:00:00.000Z","count":10}]},"source":{"files":{"readmeSize":0,"testsSize":0,"hasChangelog":true}}},"evaluation":{"quality":{"carefulness":0.41000000000000003,"tests":0,"health":1,"branding":0},"popularity":{"communityInterest":256,"downloadsCount":9436,"downloadsAcceleration":-14.564269406392683,"dependentsCount":0},"maintenance":{"releasesFrequency":0.8924657534246576,"commitsFrequency":0.27256849315068493,"openIssues":1,"issuesDistribution":0}},"score":{"final":0.41790639573051264,"detail":{"quality":0.4378770290145486,"popularity":0.15240274276618995,"maintenance":0.6662923630228046}}}