PSPDFKit for Electron Example App
- Node.js (with npm or Yarn)
- A PSPDFKit for Electron license. If you don't already have one you can request a free trial here.
All you have to do to get started is to clone the example project, set up PSPDFKit as an npm dependency, and provide your license key.
A guide on how to obtain the
NPM_KEY and the license key can be found here.
git clone https://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
The last command will automatically start the Electron application.
To open the developer tools inside Electron, uncomment the following line in
// 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:
||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
||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.
npm install -g electron-packager
Build Individual Packages
The following code will only work on macOS. For other platforms, please consult the documentation of
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)
This software is licensed under a modified BSD license.
Please ensure you have signed our CLA so that we can accept your contributions.