Skip to content

Commit c102974

Browse files
ritz078ritz078
committed
Add Gatsby.js example for PSPDFKit integration
- Created a new Gatsby.js example project demonstrating the integration of PSPDFKit for Web. - Added essential files including package.json, README.md, and configuration files for Gatsby setup. - Implemented a basic layout with a PDF viewer using PSPDFKit. - Included scripts for building and running the application, along with a post-install script to copy necessary PSPDFKit files. - Added sample PDF documents for demonstration purposes. - Introduced a .gitignore file to exclude unnecessary files and directories. - Provided detailed instructions in the README for getting started and running the example.
1 parent 9f7ace6 commit c102974

24 files changed

+15868
-1
lines changed

‎examples/elm/package-lock.json

+410
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/elm/package.json

+4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"license": "SEE LICENSE IN https://www.nutrient.io/legal/Nutrient_SDK_User_Evaluation_Subscription_Agreement",
1414
"readme": "https://www.nutrient.io/guides/web",
1515
"devDependencies": {
16+
"copy-webpack-plugin": "^12.0.2",
1617
"elm": "^0.19.1-6",
1718
"elm-webpack-loader": "^8.0.0",
1819
"html-webpack-plugin": "^5.6.3",
@@ -28,5 +29,8 @@
2829
"overrides": {
2930
"loader-utils": "^2.0.4",
3031
"cross-spawn": "^7.0.5"
32+
},
33+
"dependencies": {
34+
"@react-spring/web": "^9.7.5"
3135
}
3236
}

‎examples/gatsbyjs/.eslintrc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"extends": ["eslint:recommended"],
3+
"env": {
4+
"node": true
5+
},
6+
"rules": {
7+
"no-console": 0
8+
}
9+
}

‎examples/gatsbyjs/.gitignore

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# See https://help.github.com/ignore-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
6+
# serve and build folder
7+
/public
8+
9+
# GatsbyJS cache
10+
.cache
11+
12+
# misc
13+
.DS_Store
14+
15+
npm-debug.log*
16+
yarn-debug.log*
17+
yarn-error.log*
18+
19+
static/pspdfkit-lib

‎examples/gatsbyjs/LICENSE

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
The PSPDFKit Sample applications are licensed with a modified BSD
2+
license. In plain language: you're allowed to do whatever you wish
3+
with the code, modify, redistribute, embed in your products (free or
4+
commercial), but you must include copyright, terms of usage and
5+
disclaimer as stated in the license.
6+
7+
You will require a commercial PSPDFKit License to run these examples
8+
in non-demo mode. Please refer to [email protected] for details.
9+
10+
Copyright © 2018-present PSPDFKit GmbH.
11+
All rights reserved.
12+
13+
Redistribution and use in source or binary forms,
14+
with or without modification, are permitted provided
15+
that the following conditions are met:
16+
17+
- Redistributions of source code must retain the above copyright
18+
notice, this list of conditions and the following disclaimer.
19+
20+
- Redistributions in binary form must reproduce the above copyright
21+
notice, this list of conditions and the following disclaimer in the
22+
documentation and/or other materials provided with the
23+
distribution.
24+
25+
- Redistributions of PSPDFKit Samples must include attribution to
26+
PSPDFKit, either in documentation or other appropriate media.
27+
28+
- Neither the name of the PSPDFKit, PSPDFKit GmbH, nor its developers
29+
may be used to endorse or promote products derived from
30+
this software without specific prior written permission.
31+
32+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
35+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36+
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
39+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
40+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
41+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
42+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎examples/gatsbyjs/README.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Nutrient Web SDK Example – Gatsby.js
2+
3+
This example shows how to integrate [Nutrient Web SDK](https://www.nutrient.io/web/) into a GatsbyJS project.
4+
5+
## Prerequisites
6+
7+
- [Node.js](http://nodejs.org/)
8+
9+
## Support, Issues and License Questions
10+
11+
PSPDFKit offers support for customers with an active SDK license via https://www.nutrient.io/support/request/
12+
13+
Are you [evaluating our SDK](https://www.nutrient.io/try/)? 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://www.nutrient.io/sales/
14+
15+
## Getting Started
16+
17+
Clone the repo:
18+
19+
```bash
20+
git clone https://github.com/PSPDFKit/pspdfkit-web-example-gatsbyjs.git
21+
cd pspdfkit-web-example-gatsbyjs
22+
```
23+
24+
Install the project dependencies:
25+
26+
```bash
27+
npm install
28+
```
29+
30+
## Running the Example
31+
32+
We are ready to launch the app! 🎉
33+
34+
To run the app in development mode:
35+
36+
```bash
37+
npm run start
38+
```
39+
40+
To create a production build of the app and serve it:
41+
42+
```bash
43+
npm run build
44+
nom run serve
45+
```
46+
47+
Enjoy 🍕
48+
49+
## PSPDFKit assets
50+
51+
In order to make the example work, the PSPDFKit assets need to be copied from their original location in `./node_modules/pspdfkit/dist` to `./static`. This is done automatically from a postinstall script in located in `./scripts/copy-pspdfkit-files.js`.
52+
53+
In case copying the files fails, you can copy them manually:
54+
55+
- Copy `./node_modules/pspdfkit/dist/pspdfkit.js` to `./static/pspdfkit.js`.
56+
- Copy `./node_modules/pspdfkit/dist/pspdfkit-lib/` to `./static/pspdfkit-lib/`.
57+
58+
That's it!
59+
60+
## License
61+
62+
This software is licensed under a [modified BSD license](LICENSE).
63+
64+
## Contributing
65+
66+
Please ensure
67+
[you have signed our CLA](https://www.nutrient.io/guides/web/current/miscellaneous/contributing/) so that we can
68+
accept your contributions.

‎examples/gatsbyjs/gatsby-browser.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
import "./src/styles/global.css";

‎examples/gatsbyjs/gatsby-config.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/**
2+
* Configure your Gatsby site with this file.
3+
*
4+
* See: https://www.gatsbyjs.org/docs/gatsby-config/
5+
*/
6+
7+
module.exports = {
8+
plugins: [
9+
{
10+
resolve: "gatsby-source-filesystem",
11+
options: {
12+
name: "assets",
13+
path: `${__dirname}/static/assets/`,
14+
},
15+
},
16+
],
17+
};

‎examples/gatsbyjs/gatsby-node.js

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
const path = require("node:path");
2+
const { createFilePath } = require("gatsby-source-filesystem");
3+
4+
exports.onCreateNode = ({ node, getNode, actions }) => {
5+
const { createNodeField } = actions;
6+
7+
if (node.internal.type === "File") {
8+
const slug = createFilePath({ node, getNode, basePath: "pages" });
9+
10+
createNodeField({
11+
node,
12+
name: "slug",
13+
value: slug,
14+
});
15+
createNodeField({
16+
node,
17+
name: "title",
18+
value: node.base,
19+
});
20+
}
21+
};
22+
23+
exports.createPages = async ({ graphql, actions }) => {
24+
const { createPage } = actions;
25+
const result = await graphql(`
26+
query {
27+
allFile {
28+
edges {
29+
node {
30+
fields {
31+
slug
32+
title
33+
}
34+
}
35+
}
36+
}
37+
}
38+
`);
39+
40+
for (const { node } of result.data.allFile.edges) {
41+
createPage({
42+
path: node.fields.slug,
43+
component: path.resolve("./src/templates/Viewport.js"),
44+
context: {
45+
slug: node.fields.slug,
46+
},
47+
});
48+
}
49+
};

0 commit comments

Comments
 (0)