Skip to content

Commit 7ffa7f6

Browse files
update readme
1 parent 252aeff commit 7ffa7f6

File tree

3 files changed

+93
-6
lines changed

3 files changed

+93
-6
lines changed

LICENSE

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
License Notice
2+
3+
This folder contains code samples ("Sample Code") for use with Dynamsoft Capture Vision, a commercial software development kit licensed by Dynamsoft. The Sample Code may be modified and included in your end user software under the terms of the Dynamsoft Software License Agreement <https://www.dynamsoft.com/company/license-agreement/> ("Commercial License"). Except as expressly stated in the Commercial License, no other rights are granted in the Sample Code. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
4+
5+
Copyright © 2003–2021 Dynamsoft. All rights reserved.

LICENSE.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,88 @@
1-
# capture-vision-react-native-samples
1+
# Dynamsoft Capture Vision samples for React-Native edition
2+
3+
This repository contains multiple samples that demonstrate how to use the [Dynamsoft Capture Vision](https://www.dynamsoft.com/capture-vision/docs/introduction/) React-Native Edition.
4+
5+
## System Requirements
6+
7+
### React Native
8+
9+
- Supported Version: 0.60 or higher
10+
11+
### Android
12+
13+
- Supported OS: Android 5.0 (API Level 21) or higher.
14+
- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**.
15+
- Development Environment: Android Studio 3.4+ (Android Studio 4.2+ recommended).
16+
- JDK: 1.8+
17+
18+
### iOS
19+
20+
- Supported OS: **iOS 10.0** or higher.
21+
- Supported ABI: **arm64** and **x86_64**.
22+
- Development Environment: Xcode 7.1 and above (Xcode 13.0+ recommended), CocoaPods 1.11.0+.
23+
24+
### Others
25+
26+
- Node: 16.15.1 recommended
27+
28+
## Samples
29+
30+
| Sample Name | Description |
31+
| ----------- | ----------- |
32+
| `BarcodeReaderSimpleSample` | This is a sample that illustrates the simplest way to recognize barcodes from video streaming with Dynamsoft Capture Vision React-Native SDK. |
33+
34+
### Install the Dependencies
35+
36+
Go to your project folder and run the following command:
37+
38+
```bash
39+
yarn install
40+
```
41+
42+
or
43+
44+
```bash
45+
npm install
46+
```
47+
48+
**For 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:
49+
50+
```bash
51+
cd ios
52+
```
53+
54+
```bash
55+
pod install
56+
```
57+
58+
### Build and Run
59+
60+
- **Android**
61+
62+
Go to your project folder and run the following command:
63+
64+
```bash
65+
npx react-native run-android
66+
```
67+
68+
- **iOS**
69+
70+
In the terminal, go to the project folder in your project:
71+
72+
```bash
73+
npx react-native run-ios
74+
```
75+
76+
> Note:
77+
>
78+
>- 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.
79+
>- 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.
80+
>- 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.
81+
82+
## License
83+
84+
- You can also request an extension for your trial license in the [customer portal](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=github)
85+
86+
## Contact
87+
88+
https://www.dynamsoft.com/company/contact/

0 commit comments

Comments
 (0)