Getting started

Introduction

MobbScan can be integrated easily with any Capacitor / Ionic project.

Requirements

Node

NOTE: Several versions of Node can be installed in the same machine using nvm. Once it is installed you can install Node 20 by executing the following:

nvm install 20
nvm use 20

A NPM auth token is needed to access our repositories. If you do not have one, please contact us.

Capacitor / Ionic

The plugin works with Angular, React and Vue project types.

Installation

Add the following line in your .npmrc file in the root of your project (if it does not exist, just create it empty):

//registry.npmjs.org/:_authToken=the-provided-token

Run the following command in the root of your Capacitor project:

NOTE: This step may take several minutes because it downloads both the Android / iOS SDKs.

npm install @mobbeel/mobbscan-cordova-plugin@2.28.5

After that, you will have the MobbScan plugin installed on your webapp.

Now you just have to synchronize Capacitor:

npx cap sync

Alternatively, you can create the Android / iOS native projects at this point, if you haven't yet:

npm install @capacitor/android@6.2.0
npx cap add android
npx cap sync
npx cap open android

NOTE: It is necessary to install the CocoaPods dependencies first.

sudo gem install cocoapods
cd ios/App
pod install
npm install @capacitor/ios@6.2.0
npx cap add ios
npx cap sync
npx cap open ios

After this, you will have the MobbScan plugin installed in both of your native projects.

iOS configuration

It is necessary to add the device hardware access permissions in the info.plist file in the ios folder (App / App / info.plist).)

<key>NSCameraUsageDescription</key>
<string>Used to scan documents</string>
<key>NSMicrophoneUsageDescription</key>
<string>Used to confirm identity</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>Used to scan documents</string>

iOS SDK is distributed as a xcframework and the MobbScan plugin does not add them to Link Binaries with Libraries section, as you can see below:

Therefore, you must add all the MobbScan xcframeworks, as in the picture below:

Initialization →