{"analyzedAt":"2022-07-11T01:10:40.400Z","collected":{"metadata":{"name":"blinkinput-cordova","scope":"unscoped","version":"4.3.0","description":"A small and powerful scanning library","keywords":["scan","id","scanner","identity","ID","passport","sdk","ocr","USDL","PDF417","MRZ","MRTD","barcode","DL","card","document","microblink","blinkinput","ionic","phonegap","ecosystem:cordova","cordova-android","cordova-ios"],"date":"2020-05-27T11:23:25.189Z","author":{"name":"Microblink"},"publisher":{"username":"juraskrlec","email":"jura.skrlec@microblink.com"},"maintainers":[{"username":"juraskrlec","email":"jura.skrlec@microblink.com"}],"repository":{"type":"git","url":"git+https://github.com/BlinkInput/blinkinput-cordova.git"},"links":{"npm":"https://www.npmjs.com/package/blinkinput-cordova"},"license":"MIT","releases":[{"from":"2022-06-11T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":0},{"from":"2022-04-12T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":1},{"from":"2022-01-12T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":1},{"from":"2021-07-11T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":1},{"from":"2020-07-11T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":1}],"readme":"# BlinkInput SDK wrapper for Cordova\n\nThis repository contains example wrapper for BlinkInput native SDKs ([iOS](https://github.com/BlinkInput/blinkinput-ios) and [Android](https://github.com/BlinkInput/blinkinput-android)). Not all features of native SDKs are available in Cordova wrapper. However, the wrapper is open source, so you can easily add features that you need. For 100% of features and maximum control, consider using native SDKs.\n\n## Cordova version\nBlinkInput Cordova requires Cordova **v7.0.0 or later** and cordova-android plugin **v8.0.0 or later**.\n\n## Ionic version\n\nLatest version has been tested using Ionic **3.19.0** version.\n\n## Adding blinkinput-cordova to your application\n\nYou can add blinkinput-cordova by cloning the repository and following instructions below or by running\n\n```shell\ncordova plugin add blinkinput-cordova\n```\n\n> The shown instructions are for **Cordova**, the instructions for **Ionic** are practically the same, except for some slight command line argument differences.\n\nIn the repository you will find scripts to create sample applications.\n\n## Clone or Download repository\nDownloading a repository just downloads the files from the most recent commit of the default branch but without all the dependencies which are in submodules. We recommend that you clone directory. With a clone option you will get a copy of the history and it’s functional git repository.\n\nTo clone repository:\n\n+ **Copy URL from the `Clone or download` button: https://github.com/BlinkInput/blinkinput-cordova.git**\n+ **Open terminal on Mac/Linux or [GitBash](https://git-for-windows.github.io/) on Windows.**\n+ **cd into directory where you want the cloned directory to be made.**\n+ **Type `git clone ` , than past URL**\n+ **Press enter**\n\n## How to get started\n\n### Cordova\n\nSample Cordova app is generated with a script\n\n```shell\n./initCordovaDemoApp.sh\n```\n\nTo run iOS demo application open Xcode project `BlinkInputDemo.xcodeproj`\n\nTo run Android demo application type\n\n```shell\ncordova run android\n```\n\n### Ionic\n\nSample Ionic app is generated with a script\n\n```shell\n./initIonicDemoApp.sh\n```\n\nWhen Ionic asks the following question **Would you like to integrate your new app with Cordova to target native iOS and Android?** answer with **y**.\n\nTo run iOS demo application open Xcode project `BlinkInputDemo.xcodeproj`\n\nTo run Android demo application type\n\n```shell\nionic run android\n```\n\n### Licensing\n\n- [Generate](https://microblink.com/login?url=/customer/generatedemolicence) a **free demo license key** to start using the SDK in your app (registration required)\n\n- Get information about pricing and licensing of [BlinkInput](https://microblink.com/blinkinput)\n  \n## Installation\n\nFirst generate a empty project if needed:\n\n```shell\ncordova create <path> <package> <name>\n```\n\n> The shown instructions are for **Cordova**, the instructions for **Ionic** are practically the same, except for some slight command line argument differences.\n\nInitialize the iOS framework:\n\n```shell\ncd BlinkInput\n./initIOSFramework.sh\ncd ..\n```\n\nAdd the **BlinkInput** plugin to your project:\n\n```shell\ncd <path_to_your_project>\ncordova plugin add <blinkInput_plugin_path> # or blinkinput-cordova if you don't have blinkinput-cordova locally\n```\n\n**Ionic specific:**\n\nCopy the BlinkInput plugin's JavaScript files to your project:\n```shell\ncp  -f -r <blinkInput_plugin_path>/www/js ./www/\n```\n\n### Android\n\nAdd Android platform support to the project:\n\n    cordova platform add android@8\n    \n### iOS\n\n> If you want to add iOS as a platform for your application, you will need to install **unzip** and **wget**.\n\nAdd iOS plaform support to the project:\n\n    cordova platform add ios\n\n## Sample\n\nHere's a complete example of how to create and build a project for **Android** and **iOS** using **cordova**:\n\n```shell\n# pull the plugin and sample application from Github\ngit clone https://github.com/BlinkInput/blinkinput-cordova.git\n\n# create a empty application\ncordova create testcordova\n\ncd testcordova\n\n# add the blinkInput plugin\ncordova plugin add ../blinkinput-cordova/BlinkInput # or just 'blinkinput-cordova' if you don't have blinkinput-cordova locally\n\n# add android support to the project\ncordova platform add android@8\n\n# build the project, the binary will appear in the bin/ folder\ncordova build android\n\n# add ios support to the project\ncordova platform add ios\n\n# build the project\ncordova build ios\n```\n\nIn **cordova** CLI instead of `platform add` just request a build for the platform using `build android` or `build ios`. You will have to do the manual steps described above to be able to do a successfull build.\n\nYou can also use provided `initDemoApp.sh` script that will generate a demo app that uses the plugin:\n\n```shell\n./initCordovaDemoApp.sh\n```\n\nTo run the script, you'll need BASH environment on Windows (Linux and MacOS use BASH by default).\n\n\n## Usage\n\nTo use the plugin you call it in your Javascript code like the [demo application](www/js/index.js).\n\nDocumentation for all features and JS API is available in [blinkInputScanner.js JS API file](BlinkInput/www/blinkInputScanner.js).\n\n\n## Changing scanner settings\n\nTo change scanner settings you need to modify Cordova plugin classes for iOS and Android. Plugin classes are located in `./BlinkInput/src`. All necessary settings documentation is located in those source files. \n\nFor platform specific implementation details refer to the [BlinkInput-iOS](https://github.com/BlinkInput/blinkinput-ios) and [BlinkInput-android](https://github.com/BlinkInput/blinkinput-android) documentation."},"npm":{"downloads":[{"from":"2022-07-10T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":0},{"from":"2022-07-04T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":7},{"from":"2022-06-11T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":18},{"from":"2022-04-12T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":128},{"from":"2022-01-12T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":195},{"from":"2021-07-11T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":259}],"starsCount":0},"github":{"starsCount":5,"forksCount":0,"subscribersCount":20,"issues":{"count":5,"openCount":0,"distribution":{"3600":3,"10800":0,"32400":0,"97200":0,"291600":1,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":1,"212576400":0},"isDisabled":false},"contributors":[{"username":"juraskrlec","commitsCount":9},{"username":"matvidako","commitsCount":4}],"commits":[{"from":"2022-07-04T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":0},{"from":"2022-06-11T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":0},{"from":"2022-04-12T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":0},{"from":"2022-01-12T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":0},{"from":"2021-07-11T00:00:00.000Z","to":"2022-07-11T00:00:00.000Z","count":0}]},"source":{"files":{"readmeSize":0,"testsSize":0,"hasChangelog":true}}},"evaluation":{"quality":{"carefulness":0.41000000000000003,"tests":0,"health":1,"branding":0},"popularity":{"communityInterest":27,"downloadsCount":42.666666666666664,"downloadsAcceleration":0.06603881278538812,"dependentsCount":0},"maintenance":{"releasesFrequency":0.28664383561643836,"commitsFrequency":0,"openIssues":1,"issuesDistribution":0.1794103535353535}},"score":{"final":0.21974293349142127,"detail":{"quality":0.4378770290145486,"popularity":0.059250202654440816,"maintenance":0.1932635824514355}}}