System Requirements

Secure Context (HTTPS Deployment)

When deploying your application/website for production, make sure to serve it via a secure HTTPS connection. This is required for two reasons:

• Access to the camera video stream is only granted in a security context. Most browsers impose this restriction.
• Dynamsoft License requires a secure context to work.

Some browsers like Chrome may grant access for http://127.0.0.1 and http://localhost or even for pages opened directly from the local disk (file:///...). This can be helpful for temporary development and testing.

Browser Compatibility

Browser	Version
Chrome	v78+
Firefox	v68+
Edge	v79+
Safari	v14.5+

License

A default trial license is included which allows you to test the sample apps for up to 24 hours. You can request a 30-day trial license via the Dynamsoft website to evaluate further.

Important: Once your trial license expires, the SDK will throw an error and cease to function. Visit the Dynamsoft Customer Portal to view your trial license details. The trial period can be extended to a total of 60 days.

Running the Samples Locally

The standalone samples in the basics/ folder (hello-world.html, scan-a-single-barcode.html, read-an-image.html) and scenario samples load the SDK from a CDN, so you can open them directly by double-clicking no web server required (an internet connection is needed).

To browse all available samples, open index.html in your browser it links to every sample in the repository.

For framework samples, follow the instructions in each subfolder's README (typically npm install then npm run dev).

If you need a web server for standalone or scenario samples (for example, to serve SDK resources from a local dist/ folder), here's a quick method using Visual Studio Code:

1. Install the Five Server extension from the VS Code Marketplace.
2. Right-click on an HTML file and select "Open with Five Server". This will serve the application at http://127.0.0.1:5500/.

Sample Folders

• basics/ Three foundational samples: hello-world, scan-a-single-barcode, and read-an-image.
• scenarios/ Real-world use cases: inventory scanning, VIN reading, GS1 parsing, and more.
• frameworks/ Integrations for Angular, React, Vue, Next.js, Svelte, Blazor, Capacitor, Electron, and others.

Documentation

• Developer Guide
• API Reference

Support

Questions? Contact Dynamsoft support.

Official Online Demo

Official Online Demo: Try the Dynamsoft Barcode Reader JavaScript Edition demo (written in Vue) and see how it works in different modes!