Skip to content
Branch: master
Find file Copy path
Find file Copy path
3 contributors

Users who have contributed to this file

@aarohijohal @marianorodriguez @jvalls-axa
96 lines (63 sloc) 1.98 KB

Parsr Usage Guide

You can use Parsr in different ways:

  • Using the command line
  • Using the API
  • Using the demo web viewer

1. Install npm packages

Inside the Parsr folder (where it has been installed), launch:

npm install

2. Run

2.1. Configuration

The tool contains a pipeline of modules that process the document step by step and is highly configurable. To change it's default configuration, please refer to the configuration file documentation.

2.2. Demo: Web Viewer

To start the web viewer demo, simply run:

2.2.1. Under Linux/MacOS:

npm run start:web:vue

2.2.2. Under Windows:

In two different terminals, first:

npm run start:api

then in the other one:

cd demo/vue-viewer && npm install && npm run serve

Open localhost:8080 with your favorite browser to use the GUI.

2.3. Command Line Usage

Under Mac OS X, Linux:

npm run run:debug -- --input-file samples/t1.pdf --output-folder dist/ --document-name example --config server/defaultConfig.json --pretty-logs

Under Windows:

cmd /C "npm run run:debug -- --input-file samples/t1.pdf --output-folder samples --document-name example --config server/defaultConfig.json --pretty-logs"

3. API

Install the API server with:

npm run install:api

And then start the API server with:

npm run start:api

You can then call endpoints on localhost:3001.

The documentation for the API can be found here.

4. Test

npm run test
You can’t perform that action at this time.