@srag/pdf-wrap v0.8.2

PDF Wrap

A high level PDF abstraction library with a rich set of additional features like full text document search. Its primary goal is to provide a simple api to create your own PDF viewer.

Tasty! Isn't it?

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Consider our documentation for notes on how to deploy the project on a live system.

https://studer-raimann.github.io/pdf-wrap/

Prerequisites

• Yarn - https://yarnpkg.com/en/docs/install
• Node.js - https://nodejs.org/en/

Installing

Install dependencies

yarn install

Tasks

We use gulp for all tasks used. We recommend to not install gulp globally and use the local gulp version.

local gulp can be accessed with yarn gulp

Run yarn gulp --tasks to obtain a list of all defined tasks.

Build

Library

To build and package the library run the following command.

yarn gulp repackage

The packed library will be located at build/distributions/npm.

Documentation

The documentation is located at ./docs. In order to build the documentation run the following command.

yarn gulp mkdocs 

The html documentation will be located at ./build/docs.

Tests

Unit tests

All unit test can be run with the following command.

yarn gulp test

Coding style tests

We use TSLint to analysis our code.

yarn gulp lint

Built With

• Typescript - Javascript transpiler used
• Yarn - Package manager used
• gulp - Task automating toolkit used
• Mocha - Test framework used

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Nicolas Märchy - Initial work - BilledTrain380
• Nicolas Schäfli - d3r1w

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details

Acknowledgments

• A big fat thank you to Mozilla and their PDF.js library which is the main reason this project can exist