https://github.com/sherylynn/pdf-sync
PDF Reader in JavaScript with Sync
https://github.com/sherylynn/pdf-sync
Last synced: about 2 months ago
JSON representation
PDF Reader in JavaScript with Sync
- Host: GitHub
- URL: https://github.com/sherylynn/pdf-sync
- Owner: sherylynn
- License: apache-2.0
- Created: 2018-10-10T00:23:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-07T04:35:21.000Z (over 5 years ago)
- Last Synced: 2024-08-05T17:28:45.515Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 92 MB
- Stars: 67
- Watchers: 7
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-hacking-lists - sherylynn/pdf-sync - PDF Reader in JavaScript with Sync (JavaScript)
README
# pdf-sync
pdf-sync is add sync to pdf.js
## Contributing
pdf-sync is an open source project and always looking for more contributors. To
get involved, visit:
+ [Projects](https://github.com//sherylynn//pdf-sync)
Feel free to stop by #pdfjs on irc.mozilla.org for questions or guidance.
## Getting the Code
To get a local copy of the current code, clone it using git:
$ git clone https://github.com/sherylynn/pdf-sync.git
$ cd pdf-sync
Next, install Node.js via the [official package](https://nodejs.org) or via
[nvm](https://github.com/creationix/nvm). You need to install the gulp package
globally (see also [gulp's getting started](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md#getting-started)):
If everything worked out, install all dependencies for pdf-sync:
$ npm install
If you want to SYNC your reading process, install all dependencies for pouchDB server, and just run
$ npm run db_level
Finally, you need to start a local web server as some browsers do not allow opening
PDF files using a `file://` URL. Run:
$ npm start
and then you can open:
+ http://localhost:9000/pdf/web/index.html
It is also possible to view all test PDF files on the right side by opening:
+ http://localhost:8888/test/pdfs/?frame
## Running in electron
If you want app version, just like electron, then you can run
$ npm run app
## Building pdf-sync
In order to bundle all `src/` files into two production scripts and build the generic
viewer, run:
$ npm run build
## Building electron version pdf-sync
If you want to build your electron app, then you can just run
$ npm run dist_/*target platform*/