Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regulaforensics/document-web-components-samples
https://github.com/regulaforensics/document-web-components-samples
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/regulaforensics/document-web-components-samples
- Owner: regulaforensics
- Created: 2021-10-12T12:57:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T14:55:20.000Z (3 months ago)
- Last Synced: 2024-10-19T09:36:56.575Z (3 months ago)
- Language: TypeScript
- Size: 706 KB
- Stars: 1
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Table of сontents
1. [About](#about)
1. [CDN sample](#cdn-sample)
1. [Webpack sample](#webpack-sample)
1. [React typescript](#react-typescript)
1. [Angular sample](#angular-sample)
1. [SDK sample](#sdk-sample)
1. [Backend reprocessing sample](#backend-reprocessing-sample)
1. [API sample](#api-sample)
1. [Nuxt sample](#nuxt-sample)
1. [Next sample](#next-sample)
1. [Controller sample](#controller-sample)
1. [UI-components sample](#ui-components-sample)
1. [Switch to mobile sample](#switch-to-mobile-sample)
1. [CodePen samples](#codepen-samples)
---
## About
This repository contains examples of using [@regulaforensics/vp-frontend-document-components](https://www.npmjs.com/package/@regulaforensics/vp-frontend-document-components).
## CDN sample
The ```cdn/.html``` folder contains an example of using the component when connecting a package via a cdn link.
## Webpack sample
The ```webpack/``` folder contains an example of using components with Webpack.
### Example installation
Clone this repository then go to the ```webpack/``` folder and install the dependencies:
```
npm i
```
Build a project:
```
npm run build
```
The project files will be located in the ```build``` or ```dist``` folder.
Development mode:
```
npm run serve
```
## React typescript
The ```react-ts/``` folder contains an example of using a component with React and Typescript.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## Angular sample
The ```angular/``` folder contains an example of using a component with Angular.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## SDK sample
The ```sdk``` folder contains an example of using the SDK to develop your own interface.
## API sample
The ```api``` folder contains an example of using Document reader component with API.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## Backend reprocessing sample
The ```backend-reprocessing``` folder contains an example of using the Document reader component to further process the results on the server.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## Nuxt sample
The ```nuxt``` folder contains an example of using Document reader component with Nuxt.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## Next sample
The ```next``` folder contains an example of using Document reader component with Next.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## Controller sample
The ```controller``` folder contains an example of using the SDK to work with Regula Document Reader Web Service.
## UI-components sample
The ```ui-components``` folder contains an example of using [@regulaforensics/ui-components](https://www.npmjs.com/package/@regulaforensics/ui-components) NPM package, to display the results of document processing.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## Switch to mobile sample
The ```switch-to-mobile``` folder contains an example of using Document reader component for delegation of document scanning by a mobile device.
### Example installation
Follow the steps as in [Webpack sample](#webpack-sample).
## CodePen samples
### Camera snapshot component
https://codepen.io/regulaforensics/pen/xxLjXBJ
### Document reader component
https://codepen.io/regulaforensics/pen/KKvRypq