Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.1 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.1 KB

Barcode Scanner

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

Features

  • Scan barcodes from web camera
  • Scan barcodes from image files
  • Copy detected barcode to clipboard
  • Share detected barcode via Web Share API (Android)
  • If barcode is a URL, offer option to open in new tab
  • Offer to save detected barcodes to history (local storage)

Screenshots

Screenshot dark

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 [email protected]:hanshat/barcodescanner.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)