{"id":20596984,"url":"https://github.com/tradle/react-native-regula-document-reader","last_synced_at":"2025-03-06T15:18:35.979Z","repository":{"id":66294750,"uuid":"158991057","full_name":"tradle/react-native-regula-document-reader","owner":"tradle","description":null,"archived":false,"fork":false,"pushed_at":"2020-04-21T00:09:10.000Z","size":36711,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-17T00:53:05.205Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tradle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-11-25T02:30:38.000Z","updated_at":"2019-10-03T01:31:23.000Z","dependencies_parsed_at":"2023-02-22T13:00:58.158Z","dependency_job_id":null,"html_url":"https://github.com/tradle/react-native-regula-document-reader","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Freact-native-regula-document-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Freact-native-regula-document-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Freact-native-regula-document-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Freact-native-regula-document-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tradle","download_url":"https://codeload.github.com/tradle/react-native-regula-document-reader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242231440,"owners_count":20093636,"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-16T08:19:45.454Z","updated_at":"2025-03-06T15:18:35.960Z","avatar_url":"https://github.com/tradle.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# react-native-regula-document-reader\n\n## Getting started\n\n`npm install react-native-regula-document-reader --save`\n\n### Mostly automatic installation\n\n`react-native link react-native-regula-document-reader`\n\n#### iOS\n\n1. Add to Podfile:\n```\n  pod 'DocumentReader', '~\u003e 4.0'\n  pod 'DocumentReaderFull', '~\u003e 4.0'\n```\n1. Generate license for your application bundle ID: https://licensing.regulaforensics.com/. Convert it to a base64 string, e.g.: `fs.readFileSync('./path/to/regula.license').toString('base64')`\n1. Download database from: https://licensing.regulaforensics.com/Customer/Account/Databases. Add it to the iOS project (db.dat).\n1. Go to your project Targets -\u003e Builds Settings -\u003e Always Embed Swift Standard Libraries - set to Yes\n1. Go to your project Targets -\u003e Info -\u003e Add new key Privacy - Camera Usage Description = “Your message that will be appeared during ask to run camera”.\n\n#### Android\n\n1. Open your top level build.gradle (android/build.gradle)\n1. add the block below:\n```\nallprojects {\n  repositories {\n    maven {\n      url \"http://maven.regulaforensics.com/RegulaDocumentReader\"\n    }\n  }\n}\n```\n1. In your app level build.gradle:\n1. increate 'minSdkVersion' to 19 (if it's below)\n1. Open AndroidManifest.xml file and set: `android:allowBackup=\"true\"`\n1. `mkdir -p android/app/src/main/res/raw/`\n1. Copy `regula.license` to that folder\n1. This project comes bundled with a db.dat, but if you want to use the latest, download it from Regula and copy it to `node_modules/react-native-regula-document-reader/android/src/main/assets/Regula/`\n\n## Usage\n```js\nimport RegulaDocumentReader, { Scenario } from 'react-native-regula-document-reader';\n\n// do this early on to save some time\nawait RegulaDocumentReader.initialize({\n  licenseKey: base64LicenseKeyYouCreatedAbove\n}) \n\n// initialize on the fly, and scan\n// set options as you like\n// see Regula docs for what they mean\nawait RegulaDocumentReader.scan({\n  functionality: {\n    showTorchButton: true,\n    showCloseButton: true,\n    showCaptureButton: true,\n    showCaptureButtonAfterDelay: true,\n    showSkipNextPageButton: true,\n    videoCaptureMotionControl: true,\n    showChangeFrameButton: true,\n  },\n  customization: {\n    showHintMessages: true,\n    showHelpAnimation: true,\n  },\n  processParams: {\n    scenario: Scenario.mrz,\n    multipageProcessing: false,\n    dateFormat: 'dd-mm-yyyy',\n  },\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradle%2Freact-native-regula-document-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftradle%2Freact-native-regula-document-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradle%2Freact-native-regula-document-reader/lists"}