Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 2.15 KB

README.md

File metadata and controls

85 lines (52 loc) · 2.15 KB
Raw

Barcode/QR code Scanner

A Progressive Web Application (PWA) that scans barcodes of various formats, using the Barcode Detection API.

Note

The Barcode Detection API is part of the Fugu project. Currently it is supported only on Chromium browsers in MacOS and Android. For non-supporting browsers, a polyfill is used.

Live demo

👉 Barcode/QR code Scanner

Features

Some of the key features of the application include:

  • Scan barcodes from web camera
  • Scan barcodes from image files
  • Copy detected barcode to clipboard
  • Share detected barcode via Web Share API (mobile)
  • Offer option to open detected barcode in a new tab if it is a URL
  • Offer to save detected barcodes to history (IndexedDB)

Screenshots

The following screenshots show the application in action:

Camera scanner screenshot Image scanner screenshot

Development

Below are the instructions for setting up the development environment.

Prerequisites

  • Node.js (v20.x.x)
  • npm (v10.x.x)

Installation

Clone the repository to your local machine:

git clone git@github.com:georapbox/barcode-scanner.git

Navigate to the project's directory and install the dependencies:

npm install

Running the application

To run the application in development mode, run the following command:

npm start -- --open

This will start the development server and open the application in your default web browser.

Building the application for production

To build the application for production, run the following command:

npm run build

This will create a dist directory containing the production build of the application.

Deployment

To deploy the application, run the following command:

npm run deploy

This will build the application first and then deploy it to GitHub Pages in the gh-pages branch.

License

The MIT License (MIT)