create-webviewer-app

This package is a Command-Line Interface (CLI) scaffolding tool that installs a ready-to-run WebViewer project so the user can quickly start using the WebViewer SDK.

WebViewer is a powerful JavaScript Document SDK and UI Component Library that is a part of the Apryse PDF SDK.

Trial

WebViewer comes with a 7-day trial without any feature limitations or trial key needed. To extend the trial, you can obtain the trial key by signing-up on our developer portal.

Scaffolding Using the CLI tool

To get started using create-webviewer-app, use your preferred package manager and invoke the command with 2 parameters:

• Output directory path
  If this path already exists, it must be an empty directory. If it does not exist, it will be created by the tool.
• --key valid-WebViewer-license-key
  This could be a trial key during evaluation, or a commercial license key if you already purchased one.

Using npm

npx @apryse/create-webviewer-app output-folder --key WebViewer-license-key

Using pnpm

pnx @apryse/create-webviewer-app output-folder --key WebViewer-license-key

Using yarn. Works with v2 (Berry) and later

yarn dlx @apryse/create-webviewer-app output-folder --key WebViewer-license-key

Using bun

bunx @apryse/create-webviewer-app output-folder --key WebViewer-license-key

Using one of the commands above will start the tool and present you with options to scaffold using some of the popular frameworks (React, Angular, Vue or Next.js)

Examples

Relative path using npm with most command shells

npx @apryse/create-webviewer-app my-app --key key:ABC123

Relative path using bun with most command shells

bunx @apryse/create-webviewer-app my-app --key key:ABC123

Absolute path using yarn v2 (Berry) or later with Windows PowerShell or CMD

yarn dlx @apryse/create-webviewer-app c:\my-app --key key:ABC123

Building the Resulting Project

After the CLI tool finishes scaffolding, it will display instructions on how you can build and run the project it created.
Furthermore, the project will contain its own README.md file that contains detailed information about the project.

Licensing

WebViewer will run in trial mode until a license is provided. For more information on licensing, please visit our website.