https://github.com/yashha/percollate-api

A basic api to serve percollate as an web api
https://github.com/yashha/percollate-api

api pdf percollate readability

Last synced: 2 months ago
JSON representation

A basic api to serve percollate as an web api

• Host: GitHub
• URL: https://github.com/yashha/percollate-api
• Owner: yashha
• License: mit
• Created: 2018-10-22T22:40:25.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T11:38:15.000Z (10 months ago)
• Last Synced: 2024-08-02T16:12:20.991Z (5 months ago)
• Topics: api, pdf, percollate, readability
• Language: TypeScript
• Homepage: https://readtheweb.de/
• Size: 1.07 MB
• Stars: 5
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Description

Public API to transform website content to pdf using the [percollate package](https://github.com/danburzo/percollate) .

## Installation

```bash

$ npm install

```

## Running the app

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

# incremental rebuild (webpack)

$ npm run webpack

$ npm run start:hmr

# production mode

npm run start:prod

```

## Test

```bash

# unit tests

$ npm run test

# e2e tests

$ npm run test:e2e

# test coverage

$ npm run test:cov

```

## API

- GET: /load.pdf

  - Query: mutiple `url` queries possible  

    other queries are other options of percollate