You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.html
+23-10Lines changed: 23 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -130,12 +130,16 @@ <h2>Quick Start</h2>
130
130
131
131
<h2>System Requirements</h2>
132
132
133
-
<h3>Secure Context (HTTPS)</h3>
133
+
<h3>Secure Context (HTTPS Deployment)</h3>
134
134
<p>
135
-
Production deployments must use HTTPS. Camera access and Dynamsoft licensing both require a secure context.
135
+
When deploying your application/website for production, make sure to serve it via a secure HTTPS connection. This is required for two reasons:
136
136
</p>
137
+
<ul>
138
+
<li>Access to the camera video stream is only granted in a security context. Most browsers impose this restriction.</li>
139
+
<li>Dynamsoft License requires a secure context to work.</li>
140
+
</ul>
137
141
<pclass="callout callout-note">
138
-
For local development, <code>http://127.0.0.1</code>, <code>http://localhost</code>, and <code>file:///</code> are allowed by most browsers.
142
+
Some browsers like Chrome may grant access for <code>http://127.0.0.1</code> and <code>http://localhost</code> or even for pages opened directly from the local disk (<code>file:///...</code>). This can be helpful for temporary development and testing.
139
143
</p>
140
144
141
145
<h3>Browser Compatibility</h3>
@@ -158,18 +162,22 @@ <h2>License</h2>
158
162
to view your trial license details. The trial period can be extended to a total of 60 days.
159
163
</p>
160
164
161
-
<h2>Running Samples Locally</h2>
165
+
<h2>Running the Samples Locally</h2>
162
166
<p>
163
-
The standalone samples in <code>basics/</code> and the scenario samples load the SDK from a CDN,
164
-
so you can open them directly by double-clicking — no web server required (internet connection needed).
167
+
The standalone samples in the <code>basics/</code> folder (<code>hello-world.html</code>, <code>scan-a-single-barcode.html</code>, <code>read-an-image.html</code>) 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).
165
168
</p>
166
169
<p>
167
-
If you need a local web server (e.g., to serve SDK resources from <code>dist/</code>), a quick option using
168
-
<ahref="https://code.visualstudio.com/">Visual Studio Code</a>:
170
+
To browse all available samples, open <ahref="./index.html"><code>index.html</code></a> in your browser — it links to every sample in the repository.
171
+
</p>
172
+
<p>
173
+
For framework samples, follow the instructions in each subfolder's README (typically <code>npm install</code> then <code>npm run dev</code>).
174
+
</p>
175
+
<p>
176
+
If you need a web server for standalone or scenario samples (for example, to serve SDK resources from a local <code>dist/</code> folder), here's a quick method using <ahref="https://code.visualstudio.com/">Visual Studio Code</a>:
169
177
</p>
170
178
<ol>
171
-
<li>Install the <ahref="https://marketplace.visualstudio.com/items?itemName=yandeu.five-server">Five Server</a> extension.</li>
172
-
<li>Right-click an HTML file → "Open with Five Server" → served at <code>http://127.0.0.1:5500/</code>.</li>
179
+
<li>Install the <ahref="https://marketplace.visualstudio.com/items?itemName=yandeu.five-server">Five Server</a> extension from the VS Code Marketplace.</li>
180
+
<li>Right-click on an HTML file and select "Open with Five Server". This will serve the application at <code>http://127.0.0.1:5500/</code>.</li>
<ahref="https://demo.dynamsoft.com/barcode-reader-js"><strong>Official Online Demo</strong></a>: Try the Dynamsoft Barcode Reader JavaScript Edition demo (written in Vue) and see how it works in different modes!
0 commit comments