radazzouz / pspdfkit-electron-example

PSPDFKit for Electron Example Application

PSPDFKit for Electron Example App

This example shows how to build a PSPDFKit for Electron application with Electron.

Prerequisites

• Node.js
• A PSPDFKit for Electron license. If you don't already have one you can request a free trial here.

Getting Started

Clone the repo:

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

Install the project dependencies with npm:

npm install

Now that everything is installed we need to configure the app to use our PSPDFKit for Web license key.

Edit ./config/license-key and replace the string YOUR_LICENSE_KEY_GOES_HERE with the license key that you'll find following that link.

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

Running the Example

We are ready to launch the app! 🎉

npm run start

The Electron application will automatically start.

To open the developer tools inside Electron, uncomment the following line in index.js:

// Open the DevTools.
mainWindow.webContents.openDevTools();

What's in This Repository

This repository contains an example integration of PSPDFKit for Electron. The project structure is influenced by the default Electron example app and comes with the following files:

Filename	Description
src/index.js	The main entry point used to create the Electron windows. This file does not contain major changes, with the exception of a validation to make sure that PSPDFKit is properly installed. It is responsible for loading src/index.html.
src/index.html	The main HTML entry point. It will set up a simple HTML structure and invoke the JavaScript that runs in the renderer thread: src/renderer.js.
src/renderer.js	This file is where we import PSPDFKit and set it up properly. We use it to extend PSPDFKit for Web with custom behavior.

Build Production Packages

We recommend using electron-packager or a similar solution to build the production bundles.

Install electron-packager

npm install -g electron-packager

Build Individual Packages

The following code will only work on macOS. For other platforms, please consult the documentation of electron-packager:

npm run package-mac
npm run package-win (requires Wine: `brew cask install xquartz`, `brew install wine`)
npm run package-linux (requires `apt-get install libgconf-2-4` on target Linux)

License

This software is licensed under a modified BSD license.

Contributing

Please ensure you have signed our CLA so that we can accept your contributions.