https://github.com/doo/scanbot-sdk-example-ionic-vuejs
Easy-to-use Ionic and Capacitor document scanner and data extraction library using Vue.js
https://github.com/doo/scanbot-sdk-example-ionic-vuejs
android capacitor cross-platform document document-scanner document-scanning image ios library mrz ocr plugin processing scanner scanning sdk vue vuejs
Last synced: 16 days ago
JSON representation
Easy-to-use Ionic and Capacitor document scanner and data extraction library using Vue.js
- Host: GitHub
- URL: https://github.com/doo/scanbot-sdk-example-ionic-vuejs
- Owner: doo
- Created: 2023-02-13T10:01:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-23T13:56:50.000Z (about 1 year ago)
- Last Synced: 2025-04-23T14:43:46.558Z (about 1 year ago)
- Topics: android, capacitor, cross-platform, document, document-scanner, document-scanning, image, ios, library, mrz, ocr, plugin, processing, scanner, scanning, sdk, vue, vuejs
- Language: Vue
- Homepage:
- Size: 31 MB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Scanbot Barcode & Document Scanning Example App for Capacitor with Ionic
This example app shows how to integrate the [Scanbot Barcode Scanner SDK](https://scanbot.io/developer/ionic-barcode-scanner/), [Scanbot Document Scanner SDK](https://scanbot.io/developer/ionic-document-scanner/), and [Scanbot Data Capture SDK](https://scanbot.io/developer/ionic-data-capture/) for Capacitor.
The Scanbot SDK Capacitor Plugin is available as an [npm package](https://www.npmjs.com/package/capacitor-plugin-scanbot-sdk).
For more details about the Scanbot SDK Capacitor Plugin please refer to the [documentation](https://docs.scanbot.io/document-scanner-sdk/capacitor/).
## What is the Scanbot SDK?
The Scanbot SDK lets you integrate barcode & document scanning, as well as data extraction functionalities, into your mobile apps and website. It contains different modules that are licensable for an annual fixed price. For more details, visit our website https://scanbot.io.
## Trial License
The Scanbot SDK will run without a license for one minute per session!
After the trial period has expired, all SDK functions and UI components will stop working. You have to restart the app to get another one-minute trial period.
To try the Scanbot SDK without a one-minute limit, you can get a free “no-strings-attached” trial license. Please submit the [Trial License Form](https://scanbot.io/trial/) on our website.
## Free Developer Support
We provide free "no-strings-attached" developer support for the implementation & testing of the Scanbot SDK.
If you encounter technical issues with integrating the Scanbot SDK or need advice on choosing the appropriate
framework or features, please visit our [Support Page](https://docs.scanbot.io/support/).
## Documentation
👉 [Scanbot SDK documentation](https://docs.scanbot.io/document-scanner-sdk/capacitor/introduction/)
## How to run this app
### Requirements
- NodeJS 16+ & npm
- [Capacitor CLI](https://www.npmjs.com/package/@capacitor/cli) 5+
- For Android apps:
* Android SDK (API Level 22+), Platforms and Developer Tools
* Android Studio Flamingo | 2022.2.1 with Gradle 8, Java JDK 17
- For iOS apps:
* iOS 13+
* macOS with Xcode 14.1+
Please check the full [requirements for Capacitor](https://capacitorjs.com/docs/getting-started/environment-setup).
### Install
Install the node modules of this project:
```
cd scanbot-sdk-example-ionic-vuejs/
npm install
```
### Build
Build the web assets and sync with the Capacitor native projects:
```
npm run build
npx cap sync
```
### Run
Connect an Android or iOS device via USB and run the app from IDE or Command Line Interface (CLI).
#### IDE
Open the native projects in corresponding IDEs (Android Studio or Xcode) and hit the "Run" button:
```
npx cap open android
npx cap open ios
```
#### CLI
Or alternatively run the projects via CLI (Android or iOS):
```
npx cap run android
npx cap run ios
```