Skip to content

Latest commit

 

History

History
85 lines (48 loc) · 3.93 KB

README.md

File metadata and controls

85 lines (48 loc) · 3.93 KB
Raw

PSPDFKit for Web Example - PWA

This example shows how to integrate PSPDFKit for Web and create a PWA (Progressive Web App).

You can check out a live preview here: pspdfkit.com/pwa.

This sample application features a basic PWA setup including a manifest and a service worker, to allow your app to function offline as well as an IndexedDB storage for PDFs. This way, your files are persisted even after you close the browser.

In this example we use workbox, a popular PWA framework by Google.

Prerequisites

Support, Issues and License Questions

PSPDFKit offers support for customers with an active SDK license via https://pspdfkit.com/support/request/

Are you evaluating our SDK? That's great, we're happy to help out! To make sure this is fast, please use a work email and have someone from your company fill out our sales form: https://pspdfkit.com/sales/

Getting Started

Clone the repo:

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

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 received via e-mail.

Running the Example

We are ready to launch the app! 🎉

To run the app in development mode:

npm run start

Build Production Artifacts

To build a production version, just follow the above guide but instead of running start:

npm run build

The build script will then create a file called ./dist which you can copy to your webserver as-is.

How it works

Under ./src you can find a simple application shell that loads PSPDFKit for Web.

The application uses a service worker to provide offline support and pre-caching for the majority of the assets.

To reduce the amount of boilerplate, we use workbox - a library from Google that abstracts away some of the verbosity associated to the service worker creation and configuration.

We also use workbox-cli, another library from Google, to automatically generate a Manifest file for our ServiceWorker pre-cache when we run npm start. You can find this configuration file in ./src/workbox-config.js.

To allow PDFs to be persisted locally so they do not need to be downloaded again, we've created the PSPDFKitFileStore library. It uses a lightweight and Promise-based wrapper around the IndexedDB API called idb under the hood. The code is designed to work independently of the PWA example and can also be used in Internet Explorer 11.

Mobile Support

If you try to connect to the local development server remotely you'll quickly see that the PWA is not working as expected. This is due to the fact that the PWA APIs require a valid SSL/TLS certificate to properly function and you will probably not have this setup locally.

For a better experience, we suggest you check out the hosted PWA example or deploy a production build to your own server.

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.