{"id":26086877,"url":"https://github.com/pspdfkit/pspdfkit-electron-example","last_synced_at":"2025-04-12T03:23:17.210Z","repository":{"id":41308927,"uuid":"127118396","full_name":"PSPDFKit/pspdfkit-electron-example","owner":"PSPDFKit","description":"PSPDFKit for Electron Example Application","archived":false,"fork":false,"pushed_at":"2025-03-10T10:34:13.000Z","size":559,"stargazers_count":15,"open_issues_count":1,"forks_count":3,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-25T22:51:30.630Z","etag":null,"topics":["electron","pdf","pspdfkit","sdk"],"latest_commit_sha":null,"homepage":"https://pspdfkit.com/pdf-sdk/electron/","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PSPDFKit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-28T09:40:48.000Z","updated_at":"2025-03-19T03:52:30.000Z","dependencies_parsed_at":"2023-01-30T03:31:19.445Z","dependency_job_id":"4a898543-4cd7-4bbb-b994-e9b8b6d6fa79","html_url":"https://github.com/PSPDFKit/pspdfkit-electron-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit%2Fpspdfkit-electron-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit%2Fpspdfkit-electron-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit%2Fpspdfkit-electron-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PSPDFKit%2Fpspdfkit-electron-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PSPDFKit","download_url":"https://codeload.github.com/PSPDFKit/pspdfkit-electron-example/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248510798,"owners_count":21116277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","pdf","pspdfkit","sdk"],"created_at":"2025-03-09T07:18:40.907Z","updated_at":"2025-04-12T03:23:17.195Z","avatar_url":"https://github.com/PSPDFKit.png","language":"JavaScript","readme":"\u003e ⚠️ **Repository Moved**  \n\u003e This repository has been moved to https://github.com/PSPDFKit/nutrient-web-examples/tree/main/examples/electron.  \n\u003e Please update your bookmarks and issues accordingly.\n\u003e\n\u003e This repo is now archived and will no longer receive updates.\n\n# Nutrient Electron Example App\n\nThis example shows how to build a [Nutrient Electron](https://www.nutrient.io/electron/) application with\n[Electron](https://electronjs.org/).\n\nThis example uses context isolation, with node integration disabled. If you're looking for an example with node integration enabled, you can switch to the [`nodeintegration` branch](https://github.com/PSPDFKit/pspdfkit-electron-example/tree/nodeintegration).\n\n## Prerequisites\n\n- [Node.js](http://nodejs.org/)\n\n## Usage with a license key\n\nThe example will work out of the box in demo mode, when no license key is passed. However, if used with a license key, we need to make sure that the corresponding bundle ID is passed in the `electronAppName` property of the configuration object passed to `PSPDFKit.load()` in `src/index.html`:\n\n```js\nPSPDFKit.load({\n  // other options\n  licenseKey: \"LICENSE KEY GOES HERE\",\n  electronAppName: \"BUNDLE ID GOES HERE\",\n});\n```\n\n## Support and Issues\n\nAre 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/\n\n## Getting Started\n\nClone the repo:\n\n```bash\ngit clone https://github.com/PSPDFKit/pspdfkit-electron-example.git\ncd pspdfkit-electron-example\n```\n\nInstall the project dependencies with `npm`:\n\n```bash\nnpm install\n```\n\n**Important:** If you are using Windows, do not use PowerShell. Instead, use Microsoft’s [Developer Command Prompt for Visual Studio](https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs).\n\n## Running the Example\n\nWe are ready to launch the app! 🎉\n\n```bash\nnpm run start\n```\n\nThe Electron application will automatically start.\n\nTo open the developer tools inside Electron, uncomment the following line in `index.js`:\n\n```js\n// Open the DevTools.\nmainWindow.webContents.openDevTools();\n```\n\n## What's in This Repository\n\nThis repository contains an example integration of [Nutrient Electron](https://www.nutrient.io/electron). The project structure is influenced by the default Electron example app and comes with the following files, among other:\n\n| Filename         | Description                                                                                                                                                                                                                              |\n| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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`. |\n| `src/index.html` | The main HTML entry point. It will set up a simple HTML structure and load the PSPDFKit library and provided example document.                                                                                                           |\n| `src/preload.js` | This file is where the Node API helpers are imported and exposed to the browser window.                                                                                                                                                  |\n\n## Build Production Packages\n\nWe recommend using [`electron-packager`](https://github.com/electron-userland/electron-packager) or a similar solution to build the production bundles.\n\n### Install `electron-packager`\n\n```bash\nnpm install -g electron-packager\n```\n\n### Build Individual Packages\n\nThe following code will only work on macOS. For other platforms, please consult the [documentation](https://github.com/electron-userland/electron-packager#electron-packager) of `electron-packager`:\n\n```bash\nnpm run package-mac-intel\nnpm run package-mac-apple (Apple Silicon)\nnpm run package-win (requires Wine: `brew cask install xquartz`, `brew install wine`)\nnpm run package-linux (requires `apt-get install libgconf-2-4` on target Linux)\n```\n\n## License\n\nThis software is licensed under a [modified BSD license](LICENSE).\n\n## Contributing\n\nPlease ensure\n[you have signed our CLA](https://www.nutrient.io/guides/web/current/miscellaneous/contributing/) so that we can\naccept your contributions.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpspdfkit%2Fpspdfkit-electron-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpspdfkit%2Fpspdfkit-electron-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpspdfkit%2Fpspdfkit-electron-example/lists"}