Skip to content

Commit d0eae55

Browse files
committed
add Readmes
1 parent 52b8c5a commit d0eae55

File tree

23 files changed

+492
-62
lines changed

23 files changed

+492
-62
lines changed

README.md

Lines changed: 35 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -31,75 +31,48 @@ A default license is included which allows you to test the sample apps for up to
3131

3232
## Documentation
3333

34-
For the developer guide and full API reference of Dynamsoft Barcode Reader JavaScript library, please check out the [documentation](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/?ver=11.0.6000&utm_source=sampleReadme).
34+
For the developer guide and full API reference of Dynamsoft Barcode Reader JavaScript library, please check out the [documentation](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/?ver=11.2.2000&utm_source=sampleReadme).
3535

3636
## Support
3737

3838
If you have any questions, feel free to [contact Dynamsoft support](https://www.dynamsoft.com/company/contact?utm_source=sampleReadme).
3939

4040
## Sample list
4141

42-
### Barcode Scanner API samples
43-
44-
**Scan single barcode**
45-
46-
Get the basic features working with plain/native JavaScript or within a framework like [Angular](https://angular.io/), [React](https://reactjs.org/) or [Vue](https://vuejs.org/), with RTU-BarcodeScanner APIs.
47-
48-
* [**Scan Single Barcode**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/hello-world.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/hello-world.html?utm_source=sampleReadme): Scan single barcode from video stream with minimum code in JavaScript.
49-
* [**Scan And Search**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/scan-and-search.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/scan-and-search.html?utm_source=sampleReadme): Scan a barcode to retrieve the relevant product information from the database in JavaScript.
50-
* [**Pick One to Fill**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/pick-one-to-fill/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/pick-one-to-fill/index.html?utm_source=sampleReadme): Pick one and auto-fill fields by simply opening the camera and scanning a group of barcodes.
51-
* [**Use Customized Template**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/use-customized-template/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/use-customized-template/index.html?utm_source=sampleReadme): Use different customized templates for scanning various barcode types.
52-
* [**Hello World in Angular**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/angular): Read single barcode from camera in an Angular application.
53-
* [**Hello World in React**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/react): Read single barcode from camera in a React application.
54-
* [**Hello World in Vue**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/vue): Read single barcode from camera in a Vue application.
55-
* [**Hello World in Svelte**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/svelte): Read single barcode from camera in a Svelte application.
56-
* [**Hello World in Capacitor**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/capacitor): Read single barcode from camera in a Capacitor application.
57-
* [**Hello World in Webview**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/webview): Read single barcode from camera in a Webview application.
58-
* [**Hello World in Typescript**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/native-ts): Read single barcode from camera in a Typescript application.
59-
* [**Hello World in Electron**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/electron): Read single barcode from camera in a Electron application.
60-
* [**Hello World in Blazor**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/blazor): Read single barcode from camera in a Blazor application.
61-
* [**Hello World in RequireJS**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/requirejs.html): Read single barcode from camera in a RequireJS application.
62-
* [**Hello World in ES6**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/es6.html): Read single barcode from camera in a ES6 application.
63-
* [**Hello World in PWA**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/pwa): Read single barcode from camera in a PWA application.
64-
65-
**Scan multiple barcodes**
66-
67-
* [**Scan Multiple Barcodes**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/barcode-scanner-api-samples/scan-multiple-barcodes/hello-world.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-multiple-barcodes/hello-world.html?utm_source=sampleReadme): Scan barcodes from video stream with minimum code in JavaScript.
68-
* [**Cart Builder**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/barcode-scanner-api-samples/scan-multiple-barcodes/cart-builder.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-multiple-barcodes/cart-builder.html?utm_source=sampleReadme): Simulates a shopping experience where users scan barcodes to add items to a dynamic cart in JavaScript.
69-
* [**Batch Inventory**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/barcode-scanner-api-samples/scan-multiple-barcodes/batch-inventory/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-multiple-barcodes/batch-inventory/index.html?utm_source=sampleReadme): An inventory management tool scan barcodes in batches and provide real-time analysis of the scanned data.
70-
71-
### Foundational API samples
72-
73-
**Hello World**
74-
75-
Get the basic features of the library working with plain/native JavaScript or within a framework like [Angular](https://angular.io/), [React](https://reactjs.org/) or [Vue](https://vuejs.org/), etc.
76-
77-
* [**Hello World**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/hello-world.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/hello-world/hello-world.html?utm_source=sampleReadme): Scan barcodes from video stream with minimum code in JavaScript.
78-
* [**Read an Image**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/read-an-image.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/hello-world/read-an-image.html?utm_source=sampleReadme): Decode barcodes from images in mobile album or desktop file system.
79-
* [**Hello World in Angular**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/angular#readme): Read barcodes from camera and images in an Angular application.
80-
* [**Hello World in Blazor**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/blazor#readme): Read barcodes from camera and images in a Blazor application.
81-
* [**Hello World in React**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/react#readme): Read barcodes from camera and images in a React application.
82-
* [**Hello World in React using Hooks**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/react-hooks#readme): Read barcodes from camera and images in a React application and use the Hooks charactor of React.
83-
* [**Hello World in Vue**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/vue#readme): Read barcodes from camera and images in a Vue 3 application.
84-
* [**Hello World in Next.js**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/next#readme): Read barcodes from camera and images in a Next.js application.
85-
* [**Hello World in Nuxt**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/nuxt#readme): Read barcodes from camera and images in a Nuxt application.
86-
* [**Hello World in Electron**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/electron#readme): Read barcodes from camera and images in a Electron application.
87-
* [**Hello World in PWA**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/pwa#readme): Decode video stream in a PWA application from a webcam or a built-in camera.
88-
* [**Hello World with RequireJS**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/requirejs.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/hello-world/requirejs.html?utm_source=sampleReadme): Decode video stream in an application using RequireJS from a webcam or a built-in camera.
89-
* [**Hello World with ES6**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/es6.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/hello-world/es6.html?utm_source=sampleReadme): Decode video stream in an application using ES6 from a webcam or a built-in camera.
90-
* [**Hello World in WebView**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/hello-world/webview): Decode video stream in an application in WebView from camera.
91-
92-
***Use Cases***
93-
94-
* [**Read Video and Fill a Form**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/fill-a-form-with-barcode-reading.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/fill-a-form-with-barcode-reading.html?utm_source=sampleReadme): Read barcodes to fill a form.
95-
* [**Read a Driver's License**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/read-a-drivers-license/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/read-a-drivers-license/index.html?utm_source=sampleReadme): Read the PDF417 barcode on a driver's license (AAMVA compliant) and parse it.
96-
* [**Show Result Texts on the Video**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/show-result-texts-on-the-video.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/show-result-texts-on-the-video.html?utm_source=sampleReadme): Read barcodes via camera and show result texts on the video.
97-
* [**Locate an Item with Barcode**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/locate-an-item-with-barcode/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/locate-an-item-with-barcode/index.html?utm_source=sampleReadme): Find a specific item in a large collection by scanning its unique barcode
98-
* [**Read and Parse GS1-AI**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/read-and-parse-GS1-AI/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/read-and-parse-GS1-AI/index.html?utm_source=sampleReadme): Read GS1 Application Identifier (AI) barcode and parse its structured data.
99-
100-
***Others***
101-
102-
* [**Debug**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/others/debug#readme): Collect the actual image frames for debugging purposes.
42+
### Frameworks
43+
44+
- [Angular/](./frameworks/angular/)
45+
- [Blazor/](./frameworks/blazor/)
46+
- [Capacitor/](./frameworks/capacitor/)
47+
- [Electron/](./frameworks/electron/)
48+
- [es6/](./frameworks/es6/)
49+
- [Native-ts/](./frameworks/native-ts/)
50+
- [Next/](./frameworks/next/)
51+
- [Nuxt/](./frameworks/nuxt/)
52+
- [PWA/](./frameworks/pwa/)
53+
- [React/](./frameworks/react/)
54+
- [Requirejs/](./frameworks/requirejs/)
55+
- [Svelte/](./frameworks/svelte/)
56+
- [Vue/](./frameworks/vue/)
57+
- [Webview/](./frameworks/webview/)
58+
59+
### Scenarios
60+
61+
- [pick-one-to-fill/](./scenarios/pick-one-to-fill/)
62+
- [cart-builder](./scenarios/cart-builder.html)
63+
- [scan-and-search](./scenarios/scan-and-search.html)
64+
- [show-result-texts-on-the-video](./scenarios/show-result-texts-on-the-video.html)
65+
- [batch-inventory/](./scenarios/batch-inventory/)
66+
- [read-a-drivers-license/](./scenarios/read-a-drivers-license/)
67+
- [read-and-parse-GS1-AI/](./scenarios/read-and-parse-GS1-AI/)
68+
- [scan-qr-code/](./scenarios/scan-qr-code/)
69+
- [scan-any-codes/](./scenarios/scan-any-codes/)
70+
- [scan-common-2D-codes/](./scenarios/scan-common-2D-codes/)
71+
- [scan-1D-Retail/](./scenarios/scan-1D-Retail/)
72+
- [scan-1D-Industrial/](./scenarios/scan-1D-Industrial/)
73+
- [scan-from-distance/](./scenarios/scan-from-distance/)
74+
- [locate-an-item-with-barcode/](./scenarios/locate-an-item-with-barcode/)
75+
- [debug/](./scenarios/debug/)
10376

10477
### Official Online Demo
10578

frameworks/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Frameworks samples
2+
3+
This directory contains framework-specific examples demonstrating how to integrate the Dynamsoft Barcode Reader (JavaScript edition) into common web and hybrid frameworks. Each framework folder contains one or more runnable sub-examples (for example, scan-using-foundational-api and/or scan-using-rtu-api) showing practical integration patterns.
4+
5+
## Sample list
6+
7+
- [frameworks/angular/](./frameworks/angular/) — Angular examples.
8+
- [frameworks/blazor/](./frameworks/blazor/) — Blazor (.NET) examples.
9+
- [frameworks/capacitor/](./frameworks/capacitor/) — Capacitor mobile hybrid examples.
10+
- [frameworks/electron/](./frameworks/electron/) — Electron desktop examples.
11+
- [frameworks/es6/](./frameworks/es6/) — Plain ES6 module examples.
12+
- [frameworks/native-ts/](./frameworks/native-ts/) — Native TypeScript examples.
13+
- [frameworks/next/](./frameworks/next/) — Next.js examples.
14+
- [frameworks/nuxt/](./frameworks/nuxt/) — Nuxt examples.
15+
- [frameworks/pwa/](./frameworks/pwa/) — Progressive Web App examples.
16+
- [frameworks/react/](./frameworks/react/) — React examples.
17+
- [frameworks/requirejs/](./frameworks/requirejs/) — RequireJS (AMD) examples.
18+
- [frameworks/svelte/](./frameworks/svelte/) — Svelte examples.
19+
- [frameworks/vue/](./frameworks/vue/) — Vue examples.
20+
- [frameworks/webview/](./frameworks/webview/) — Native WebView examples for Android/iOS.
21+
22+
## Quick start
23+
24+
1. Browse into a framework subfolder and choose a subexample, e.g.:
25+
- cd frameworks/react/scan-using-foundational-api
26+
2. Follow the subexample README for exact steps. Typical commands:
27+
- npm install
28+
- npm run dev (or npm start / npm run build per the subexample)
29+
3. Open the local dev URL shown in the terminal (ensure you use localhost or HTTPS for camera access).
30+
31+
## Notes
32+
33+
- Serve examples via the framework dev server or a local HTTP server; opening files directly (file://) may break module loading or camera permissions.
34+
- Camera and microphone access require a secure context (https or localhost).
35+
- A trial license is included for short-term testing; request a longer trial from Dynamsoft for extended evaluation.
36+
- For general instructions, license info and API docs, see the repository root README.md.
37+
38+
If a sub-example provides a README, follow it for platform-specific details and additional troubleshooting tips.

frameworks/angular/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Angular samples
2+
3+
This directory contains Angular-based examples demonstrating how to use the Dynamsoft Barcode Reader (JavaScript edition) in Angular projects.
4+
5+
Included examples
6+
- scan-using-foundational-api/ — Example using the foundational API.
7+
- scan-using-rtu-api/ — Example using the RTU API.
8+
9+
Quick start
10+
1. Change to a subexample directory, e.g.:
11+
- cd scan-using-foundational-api
12+
2. Follow the subexample README for exact steps (typically: npm install && npm run start or ng serve).
13+
14+
Notes
15+
- Run examples via the framework dev server. Opening files directly may break module loading or camera access.
16+
- See the repository root README.md for general usage and license information.

frameworks/blazor/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Blazor samples
2+
3+
This directory contains Blazor examples demonstrating how to integrate the Dynamsoft Barcode Reader (JavaScript edition) into Blazor apps.
4+
5+
Included examples
6+
- scan-using-foundational-api/ — Blazor example with JS interop for video/image decoding.
7+
- scan-using-rtu-api/ — RTU API demo for Blazor.
8+
9+
Quick start
10+
1. Change to a subexample directory, e.g.:
11+
- cd scan-using-foundational-api
12+
2. Follow the subexample README for exact steps (may require dotnet/SDK commands or npm for static assets).
13+
14+
Notes
15+
- Some examples use JS interop; run the app via dotnet or the provided launch configuration.
16+
- See the repository root README.md for general usage and license information.

frameworks/capacitor/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Capacitor samples
2+
3+
This directory contains Capacitor examples showing how to use the Dynamsoft Barcode Reader in hybrid mobile apps (Android / iOS) via Capacitor.
4+
5+
Included examples
6+
- scan-using-rtu-api/ — Capacitor project illustrating RTU API usage.
7+
8+
Quick start
9+
1. Change to the example directory, e.g.:
10+
- cd scan-using-rtu-api
11+
2. Follow the subexample README for platform-specific setup (npm install, capacitor sync, open Android Studio/Xcode).
12+
13+
Notes
14+
- Mobile platform setup is required to run native apps. See the subexample README for exact steps.
15+
- See the repository root README.md for general usage and license information.

frameworks/electron/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Electron samples
2+
3+
This directory contains Electron examples demonstrating desktop apps using the Dynamsoft Barcode Reader (JavaScript edition).
4+
5+
Included examples
6+
- scan-using-foundational-api/ — Electron demo using foundational API.
7+
- scan-using-rtu-api/ — Electron demo using RTU API.
8+
9+
Quick start
10+
1. Change to a subexample directory, e.g.:
11+
- cd scan-using-foundational-api
12+
2. Follow the subexample README for exact steps (typically: npm install && npm run start or npm run electron).
13+
14+
Notes
15+
- Desktop examples may require additional native build steps for packaging. Run via the provided dev command.
16+
- See the repository root README.md for general usage and license information.

frameworks/es6/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ES6 samples
2+
3+
This directory contains plain ES6 module examples demonstrating basic usage of the Dynamsoft Barcode Reader in vanilla JavaScript (ES6 modules).
4+
5+
Included examples
6+
- scan-using-foundational-api/ — Plain ES6 page using foundational API.
7+
- scan-using-rtu-api/ — ES6 page using RTU API.
8+
9+
Quick start
10+
1. Change to the example directory (or open repository root).
11+
2. Serve files with a local static server and open the HTML page (e.g., python -m http.server or npx http-server).
12+
13+
Notes
14+
- ES6 modules require serving over HTTP; opening files directly in the browser may not work.
15+
- See the repository root README.md for general usage and license information.

0 commit comments

Comments
 (0)