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
{{ message }}
This repository was archived by the owner on Jul 28, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+6-19Lines changed: 6 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,37 +1,25 @@
1
1
# BlinkID In-browser SDK
2
2
3
-
## How to run this repo?
4
-
5
-
Test this repo quickly on your machine (assuming you have Node and Git installed) by doing the following steps:
6
-
7
-
- clone [this](https://github.com/BlinkID/blinkid-in-browser) repo by running `git clone https://github.com/BlinkID/blinkid-in-browser` in your Terminal
8
-
- run `cd blinkid-in-browser/examples/getting-started && npm install && npm run dev`
9
-
- get the license at [Microblink DevHub](https://developer.microblink.com/) and add it to the `LICENSE` variable in the `main.js` file in the `examples/getting-started` folder
10
-
- open [http://localhost:5173/](http://localhost:5173/)
11
-
- port may be different in your case, check the output of the `npm run dev` command noted above
12
-
- point your ID towards the camera
13
-
14
-
If you prefer a short, 3 minute, video for running this project, feel free to check it out [here](https://www.youtube.com/watch?v=c0ZA8af9oBc).
15
-
16
-
If you want to recreate this project from scratch, step by step, please check out this tutorial: [Integrating ID Scanning and Extraction In Web Apps With BlinkID SDK](examples/getting-started/).
BlinkID In-browser SDK enables scanning of various identity documents, including driving licenses, national identity cards, passports and others. The SDK provides real-time in-browser data extraction, without any need for sending images to servers for processing.
24
6
25
7
For more information on how to integrate BlinkID SDK into your web app, read the [instructions](#integration) below. Make sure you read the latest [CHANGELOG.md](CHANGELOG.md) file to see the most recent changes and improvements.
26
8
27
9
Check out the [official demo app](https://demo.microblink.com/in-browser-sdk/blinkid/) or live examples of BlinkID SDK in action:
28
10
29
11
1.[BlinkID SDK with built-in UI](https://blinkid.github.io/blinkid-in-browser/ui/demo.html)
12
+
* See what the bare UI looks like at [Codepen](https://codepen.io/microblink/pen/GRZGQab)
30
13
2.[Scan the front side of an identity document with a web camera](https://blinkid.github.io/blinkid-in-browser/examples/blinkid-camera/javascript/index.html)
14
+
* See example at [Codepen](https://codepen.io/microblink/pen/gOPJoRp)
31
15
3.[Scan the front side of an identity document by uploading its image](https://blinkid.github.io/blinkid-in-browser/examples/blinkid-file/javascript/index.html)
16
+
* See example at [Codepen](https://codepen.io/microblink/pen/ExPzzda)
32
17
4.[Scan both sides of an identity document with a web camera](https://blinkid.github.io/blinkid-in-browser/examples/multi-side/javascript/index.html)
18
+
* See example at [Codepen](https://codepen.io/microblink/pen/BajeeMx)
33
19
5.[Scan both sides of an identity document by uploading its image](https://blinkid.github.io/blinkid-in-browser/examples/multi-side-file/javascript/index.html)
20
+
* See example at [Codepen](https://codepen.io/microblink/pen/MWboMrr)
34
21
6.[Scan barcode from an identity document from web camera](https://blinkid.github.io/blinkid-in-browser/examples/idbarcode/javascript/index.html)
22
+
* See example at [Codepen](https://codepen.io/microblink/pen/NWxVVJO)
35
23
36
24
To see the source code of the above examples, check out the [examples directory](examples). If you'd like to run examples of the UI component, either through the browser or locally, see the [ui/examples](ui/examples) directory.
37
25
@@ -40,7 +28,6 @@ Please keep in mind that BlinkID In-browser SDK is meant to be used natively in
0 commit comments