document-scanner-javascript/samples/frameworks at main · Dynamsoft/document-scanner-javascript · GitHub
Skip to content

Latest commit

 

History

History

Folders and files

README.md

Mobile Document Scanner - Angular, React, and Vue

These samples demonstrate how to use the DocumentScanner API from the Dynamsoft Mobile Document Scanner SDK in Angular, React (with hooks), and Vue apps to capture and correct a document with the camera.

Features

  • Easy integration with pre-built UI
  • Captures and auto-corrects a document from the camera
  • Displays the corrected document image
  • Self-hosts the Dynamsoft Capture Vision engine, runtime data, and camera UI
  • Angular: Renders DocumentScanner inside an Angular component (Angular CLI stack)
  • React: Renders DocumentScanner inside a React component
  • Vue: Renders DocumentScanner inside a Vue component

Quick Start

Warning

Mobile Document Scanner JS requires a valid license key to operate. Please see the licensing documentation to sign up for a free trial or a full license.

1. Install Dependencies

Navigate to the root directory of one of the framework samples:

npm install

2. Serve the Application

npm run dev

Then open the URL presented in the console to view the sample app. Replace "YOUR_LICENSE_KEY_HERE" in the component source with your license key.

3. Build for Production

npm run build

You can preview the production build for React and Vue by additionally running:

npm run preview

User Guide

Read the official documentation to learn how to use and configure the Mobile Document Scanner:

Support

If you have any questions, feel free to contact Dynamsoft Support.