WebViewer Real Time Collaboration Sample - using WebSocket, SQLite3 and Node.js server

WebViewer is a powerful JavaScript-based PDF Library that's part of the PDFTron PDF SDK. It allows you to view and annotate PDF files on your web app with a fully customizable UI.

This is a WebViewer sample to show how you can construct a real time collaboration server for WebViewer through WebSocket, SQLite3, and Node.js server.

The below diagram depicts the structure of the real time collaboration sample app.

Initial setup

Before you begin, make sure your development environment includes Node.js.

Install

git clone https://github.com/PDFTron/webviewer-realtime-collaboration-sqlite3-sample.git
cd webviewer-realtime-collaboration-sqlite3-sample
npm install

Run

npm start

How to use

Open browser window in incognito mode and go to port 3000
Create annotations with annotations tools in the header
See the changes being applied in real time in other windows
You can access the real time server from a different device in the same network via replacing localhost in your URL to the server's IP address.

Related resources

If you are also using PDFTron's Android SDK, you can find the corresponding Android sample that will work out-of-box with this project: Android CollabWebSocketSample.

Contributing

See contributing.

License

See license.

HossamTuwano/webviewer-realtime-collaboration-sqlite3-sample