Example Project

PSPDFKit for Electron comes with a ready-to-use example app. For more API examples, you might also want to take a look at our PSPDFKit for Web examples.

PSPDFKit for Electron Example App

This example shows how to integrate PSPDFKit for Electron into an Electron application.

View and download the source code on GitHub.

Prerequisites

• Node.js (with npm)
• PSPDFKit for Electron npm and license key (go here to request an evaluation trial or click here if you’re an existing customer

Getting Started

All you have to do to get started is clone this example project, set up PSPDFKit as an npm dependency, and provide your license key:

1
2
3
4
5
6
7
8
9

git clone git@github.com:PSPDFKit/pspdfkit-electron-example.git
cd pspdfkit-electron-example

echo YOUR_LICENSE_KEY_GOES_HERE > ./config/license-key

npm install --save https://customers.pspdfkit.com/npm/YOUR_NPM_KEY_GOES_HERE/latest.tar.gz

npm install
npm start

Important: If you are using Windows, do not use PowerShell. Instead, use Microsoft’s Developer Command Prompt for Visual Studio.

Next Steps

Now that you’re running an Electron application featuring PSPDFKit for Electron, it’s time to start integrating it into your own project.

Please refer to the README in the repo for more information about this example project.