Skip to content

sherylynn/pdf-sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e248c2c · Dec 18, 2019
Oct 21, 2017
Dec 18, 2019
Jul 24, 2019
Sep 28, 2018
Oct 4, 2018
Aug 30, 2018
Sep 28, 2018
Nov 14, 2018
Nov 2, 2018
Nov 14, 2018
Oct 25, 2018
Oct 7, 2018
Feb 22, 2019
Dec 18, 2019
Nov 14, 2015
May 19, 2017
Sep 9, 2018
Oct 29, 2015
Apr 15, 2019
Jul 17, 2015
Nov 22, 2017
Oct 27, 2016
Nov 29, 2017
Oct 23, 2017
Feb 17, 2015
Nov 15, 2018
Jul 20, 2019
Jul 24, 2019
Nov 14, 2018
Feb 22, 2019
Dec 18, 2019
Oct 30, 2017
Nov 12, 2018
Sep 8, 2019

Repository files navigation

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:

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 or via nvm. You need to install the gulp package globally (see also gulp's 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:

It is also possible to view all test PDF files on the right side by opening:

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*/