Skip to content
master
Go to file
Code

README.md

PSPDFKit for Web Example – React.js

This example shows how to integrate PSPDFKit for Web into a React app created with Create React App.

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-react.git
cd pspdfkit-web-example-react

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.

Open up the package.json file from this repo, find and replace all the occurrences of 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

To create a production build of the app and serve it:

npm run build
serve -s build

Enjoy 🍕

React Component

The React component which implements the PSPDFKit for Web integration can be found at src/components/pspdfkit/index.js.

To run this example via Create React App we also had to configure the baseUrl that PSPDFKit for Web uses to load its artifacts and base css. Please take a look at src/App.js.

In order to make the files above available we had to copy them from the node_modules/pspdfkit/dist folder using a script which you can find at scripts/copy-pspdfkit-files.

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.

You can’t perform that action at this time.