Skip to content

README.md

Latest commit

 

History

History
64 lines (39 loc) · 2.71 KB

README.md

File metadata and controls

64 lines (39 loc) · 2.71 KB

Mobile Document Scanner - Vue

Important

This article builds on the prerequisite MDS developer guide for plain JavaScript; please read it before proceeding.

Mobile Document Scanner integrates easily with Vue applications. Just as in plain JavaScript, you can add document scanning in your Vue application in just a few lines of code, and achieve most customizations through the same accessible configuration object.

Features

  • Easy integration with pre-built UI
  • Render MDS inside a Vue component
  • Capture and process documents from video stream
  • Automatic document detection and cropping
  • Mobile-optimized scanning interface
  • TypeScript support with type definitions

Requirements

License

Get a Trial License

Try MDS by requesting a trial license through our customer portal. You can renew the license twice for up to a total of two months of free access.

Get a Full License

Contact us to purchase a full license.

Quick Start

We publish MDS library files on npm to make them simple to reference from a CDN. We reference the library files in our ready-made Hello World sample for Vue included in our GitHub source repository:

  1. Download MDS from GitHub as a compressed folder.

  2. Extract the contents of the archive, and open the extracted directory in a code editor.

  3. Set your license key in the Vue framework sample:

    1. Open the sample at /samples/frameworks/vue/src/App.vue.
    2. Search for "YOUR_LICENSE_KEY_HERE", then replace it with your actual license key.

Install Dependencies

npm install

Start the App

npm run dev

Then open http://localhost:5173/ to view the sample app.

Customization

Please check the official documentation.

Support

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