https://github.com/dynamsoft/capture-vision-react-native-samples
Dynamsoft Capture Vision React-Native SDK Samples
https://github.com/dynamsoft/capture-vision-react-native-samples
1d-barcode barcode datamatrix document-scanner label-recognition linear-barcode npm-package pdf417 qrcode react-native
Last synced: 22 days ago
JSON representation
Dynamsoft Capture Vision React-Native SDK Samples
- Host: GitHub
- URL: https://github.com/dynamsoft/capture-vision-react-native-samples
- Owner: Dynamsoft
- License: other
- Created: 2021-03-29T07:33:18.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T10:05:04.000Z (24 days ago)
- Last Synced: 2025-04-10T11:38:18.905Z (24 days ago)
- Topics: 1d-barcode, barcode, datamatrix, document-scanner, label-recognition, linear-barcode, npm-package, pdf417, qrcode, react-native
- Language: HTML
- Homepage: https://www.dynamsoft.com/capture-vision/docs/introduction/
- Size: 869 KB
- Stars: 18
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dynamsoft Capture Vision samples for React-Native edition
This repository contains multiple samples that demonstrate how to use the [Dynamsoft Capture Vision](https://www.dynamsoft.com/capture-vision/docs/core/introduction/) React-Native Edition.
## What is Dynamsoft Capture Vision SDK
[Dynamsoft Capture Vision (DCV)](https://www.dynamsoft.com/capture-vision/docs/core/introduction/) is an aggregating SDK of a series of specific functional products, which cover image capturing, content understanding, result parsing, and interactive workflow.
- Dynamsoft Barcode Reader (DBR), Dynamsoft Document Normalizer (DDN), and Dynamsoft Label Recognizer (DLR) play crucial roles in reading barcodes, structures, and texts from images.
- Dynamsoft Code Parser (DCP) is utilized to extract meaningful fields from text/bytes results, ensuring optimal data parsing capabilities.
- To view and edit the output results, Dynamsoft Camera Enhancer (DCE) provides a suite of robust viewing and editing functions.
## API References
The API References can be found here: [API References](https://dynamsoft.github.io/capture-vision-react-native-samples/APIReferences)
## Samples
| Sample Name | Description |
|------------------------------------------------------|--------------------------------------------------------------------------------------|
| [ScanBarcodes](./ScanBarcodes)| This sample illustrates the simplest way to recognize barcodes from video streaming. |
| [DetectAndDeskewDocument](./DetectAndDeskewDocument) | This sample illustrates how to detect and deskew a document from video streaming. |
| [ScanMRZ](./ScanMRZ) | This sample illustrates how to scan passport and ID cards from video streaming. |
| [ReadDriverLicense](./ReadDriverLicense)| This sample illustrates how to scan drivers' license from video streaming. |
### How to build and run a sample
1. Enter a sample folder that you want to try
```bash
cd ScanBarcodes
```
or
```bash
cd DetectAndDeskewDocument
```
or
```bash
cd ScanMRZ
```
or
```bash
cd ReadDriverLicense
```
2. Install node modules
Run the following command:
```bash
yarn install
```
or
```bash
npm install
```
3. Prepare iOS
You must install the necessary native frameworks from CocoaPods to run the application. In order to do this, the `pod install` command needs to be run as such:
```bash
cd ios
pod install
```
Open the **workspace** file `*.xcworkspace` (not .xcodeproj) from the `ios` directory in Xcode. Adjust *Provisioning* and *Signing* settings.
4. Build and Run
- **Android**
Go to your project folder and run the following command:
```bash
# using npm
npm run android
# OR using Yarn
yarn android
```
- **iOS**
In the terminal, go to the project folder in your project:
```bash
# using npm
npm run ios
# OR using Yarn
yarn ios
```
If everything is set up _correctly_, you should see your new app running on your device.
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
> [!NOTE]
> If you want to run Android via `Windows`, You may encounter some build errors due to the `Windows Maximum Path Length Limitation`.
> Therefore, we recommend that you move the project to a directory with a shorter path.
> [!NOTE]
>
>- The application needs to run on a physical device rather than a simulator as it requires the use of the camera. If you try running it on a simulator, you will most likely run into a number of errors/failures.
>- On iOS, in order to run the React Native app on a physical device you will need to install the [`ios-deploy`](https://www.npmjs.com/package/ios-deploy) library. Afterwards, you can run the react native app from the terminal as such `npx react-native run-ios --device` assuming it's the only device connected to the Mac.
>- Alternatively on iOS, you can simply open the xcworkspace of the project found in the `ios` folder using Xcode and run the sample on your connected iOS device from there. The advantage that this offers is that it is easier to deal with the developer signatures for deployment in there.
### How to use the new architecture of React Native (Optional)
[How to enable new architecture in Android](https://reactnative.dev/architecture/landing-page#android)
[How to enable new architecture in iOS](https://reactnative.dev/architecture/landing-page#ios)
## Integration Guide For Your Project
- [Ready-to-use Barcode Scanner Integration Guide](./ready-to-use-barcode-scanner-guide.md)
- [Foundational Barcode Reader Integration Guide](./foundation-barcode-reader-guide.md)
- [Document Scanner Integration Guide](./document-scanner-guide.md)
- [MRZ Scanner Integration Guide](./mrz-scanner-guide.md)
- [Divers' License Scanner Integration Guide](./drivers-license-scanner-guide.md)
## License
- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dcv&utm_source=github&package=mobile) link.
## Contact
https://www.dynamsoft.com/company/contact/