files_pdfviewer icon indicating copy to clipboard operation
files_pdfviewer copied to clipboard

:book: A PDF viewer for Nextcloud

files_pdfviewer

This application integrates the PDF.js library into Nextcloud's Viewer. You can view PDF files as well as Adobe Illustrator files (.ai)

🏗 Development setup

  1. ☁ Clone this app into the apps folder of your Nextcloud: git clone https://github.com/nextcloud/files_pdfviewer.git
  2. ☁ Clone the viewer app into the apps folder of your Nextcloud: git clone https://github.com/nextcloud/viewer.git
  3. 👩‍💻 In the folder of the files_pdfviewer app, run the command npm ci && npm run dev to install dependencies and build the Javascript.
  4. ✅ Enable the app through the app management of your Nextcloud (viewer should be enabled by default)
  5. 🎉 Partytime! Help fix some issues and review pull requests 👍

🧙 Advanced development stuff

To build the Javascript whenever you make changes, you can also use npm run build. Or npm run watch to automatically rebuild on every file save.

You run all tests by using make test.

📦 Update pdf.js

When a new release of pdf.js is available on https://github.com/mozilla/pdf.js/releases, update the version number on https://github.com/nextcloud/files_pdfviewer/blob/master/pdfjs-get.js#L8 and compile the app again.

♥ How to create a pull request

This guide will help you get started:

✌ Code of conduct

The Nextcloud community has core values that are shared between all members during conferences, hackweeks and on all interactions in online platforms including Github and forums. If you contribute, participate or interact with this community, please respect our shared values. 😌