Run our Sample Apps

The best way to start working with the Scandit Data Capture SDK is to run one of our sample apps. In this guide we will go through the available apps and how to run them.

Available Samples

We have created both simple and advanced samples that show you how use various features of the Scandit Data Capture SDK. The simple samples allow you to get going quickly, while the advanced samples show you how to use additional settings and setup the scanner for the best user experience.

Here’s a list of our available samples on React Native:

Run the Samples

Before you can run a sample app, you need to go through a few simple steps:

  1. Sign in to your Scandit account and download the newest React Native plugins at ssl.scandit.com/dashboard/sign-in. Unzip the archive and go to the samples folder.

  2. Set the license key. To do this, sign in to your Scandit account and find your license key at ssl.scandit.com/dashboard/sign-in.

Once you have the license key, add it to the sample that you’d like to run:

DataCaptureContext.forLicenseKey('-- ENTER YOUR SCANDIT LICENSE KEY HERE --')

  1. Install the dependencies.

yarn install

# iOS only
cd ios && pod install

Note

If you’re using the zip archive downloaded from the dashboard, make sure that you’re using yarn to run the samples. The samples in the archive reference the plugins in the same archive through a relative path, which is handled differently by npm and can lead to issues when you’re trying to run the app.

  1. Run the sample. We recommend running the samples on a physical device as otherwise no camera is available.

react-native run-[ios|android] --device

Note

You probably need to setup signing for iOS. To do this, open the Xcode project and setup signing in the project settings. You can also run the sample from Xcode by clicking the Build & Run button.

New! Pre-built Barcode Scanning Component Samples

Scandit offers building blocks that can be integrated in just a few lines of code. The pre-built camera UI has been designed and user-tested to achieve superior process efficiency, ergonomics and usability.

ListBuildingSample

BarcodeSelectionSimpleSample

MatrixScanCountSimpleSample

A basic sample that demonstrates how to populate a list of scanned barcodes using the Scandit SparkScan API.

Basic sample that uses the Barcode Selection API.

Sample which shows how you can scan barcodes in batches and add them to an inventory list.

SearchAndFindSample

Demonstrates a use case that requires a consecutive use of both Barcode Capture and MatrixScan Find in a single app.

Fully-customizable API: Single Scanning with Barcode Capture Samples

The Barcode Capture API offers developers a high level of flexibility with unlimited options for designing your own UI and workflow. You can use these samples as a starting point. We recommend that you familiarize yourself with our Best Practices for Usability to learn what to consider when using the Fully-customizable API.

BarcodeCaptureSimpleSample

BarcodeCaptureRejectSample

BarcodeCaptureSettingsSample

Basic sample that uses the camera to read a single barcode.

Sample that uses the camera to read a single QR code that starts with “09:” but ignores/rejects all other codes.

Demonstrates how you can adapt the scanner settings best to your needs and experiment with all the options.

BarcodeCaptureViewsSample

Demonstrates the various ways to best integrate the scanner into the UI of your app.

Fully-customizable API: MatrixScan Samples

The Barcode Tracking API offers developers a high level of flexibility with unlimited options for designing your own UI and workflow. You can use these samples as a starting point. We recommend that you familiarize yourself with our Best Practices for Usability to learn what to consider when using the Fully-customizable API.

MatrixScanSimpleSample

MatrixScanRejectSample

MatrixScanBubblesSample

Very simple sample which shows how you can highlight barcodes on screen with the Scandit Data Capture SDK.

Sample which shows how you can highlight selected (by a custom condition) barcodes on screen and scan them with the Scandit Data Capture SDK.

Demonstrates the use of more advanced augmented reality use cases with the Scandit Data Capture SDK.

ID Scanning and Verification Samples

IdCaptureSimpleSample

A basic ID Capture setup to scan front of ID Cards and barcodes from AAMVA documents.

Text Capture Samples

TextCaptureSample

A basic Text Capture setup to recognize GS1 and LOT and integrate the parser.

All our samples can be found in the archive that can be downloaded from our dashboard. Check the following section for more details.

Next steps

You are now ready to tackle the following guide: