On this page

Stuck? Open a support ticket and the barKoder team will help. Open a ticket

Installation

This is a guide for the Capacitor plugin powered by the barKoder Barcode Scanner SDK.

Before you start #

Requirements #

Capacitor is a cross-platform app runtime that makes it easy to build web apps that run natively on iOS, Android and the web. To get started with building apps using Capacitor, you'll need to meet certain requirements:

Node.js and npm #

Ensure you have Node.js installed on your machine. Capacitor requires Node.js version 10 or later.npm (Node Package Manager) is also required. It usually comes with Node.js.

☑ <a href="https://nodejs.org/en">Download Node.js</a> and verify installation:

Shell
node -v  
npm -v

Text Editor or IDE #

Choose an editor to write your code. Popular options include:

☑ <a href="https://code.visualstudio.com/">Visual Studio Code</a>

☑ Atom, Sublime Text, or any other editor you prefer.

Capacitor projects are often version-controlled using Git.

Download Git and verify installation:
Shell
git --version

Command Line Interface (CLI) #

Capacitor commands are executed via the command line. 

Make sure you have a command line interface (CLI) installed and accessible on your system.

Mobile Development SDKs #

Platform-specific SDKs are required to build and run apps:

Capacitor Project #

Here are the basic steps:

Install Capacitor #

Shell
npm install -g @capacitor/cli

Add Platforms #

Shell
npx cap add ios  
npx cap add android

Open Your IDE and Start Coding #

Use your preferred IDE or text editor to build your app using web technologies (HTML, CSS, JavaScript/TypeScript).

Build and Run on Platforms #

Use Capacitor commands to build and launch your app:

Shell
npx cap open ios  
npx cap open android

1. Add the package #

Install #

BATCH
npm install barkoder-capacitor
npx cap sync

2. Set the license key and barcode types #

Licensing #

The SDK will scan barcodes even without a license, but results will come with an "(Unlicensed)" prefix.If you want to test the SDK today create a trial license https://barkoder.com/request-quote or just sign-up at barkoder.com/register to access all barKoder features.