Git Product home page Git Product logo

pdf-to-images's Introduction

pdf-to-images

RESTful API that converts PDF files into PNG images

Dependencies

This required imagemagick, ghostscript, and poppler installed in your system to run properly

Install Instructions

  • git clone https://github.com/aveliz1999/pdf-to-images
  • cd pdf-to-images
  • npm install

Usage

Start the server with npm start

The API is exposed in port 3000 (or whatever PORT variable is specified in the environment).

A POST request to / with a pdf file with field name pdf will return a JSON object with the schema

{
    requestId: The request ID,
    pages: The number of pages
}

To retrieve the images, use a GET request to /requestId/index where requestID is the returned request ID from the POST request, and index is the index of the image (starting at 0).

Cleanup

The cleanup task is run periodically to clean up files.

By default the cleanup runs once every hour, and cleans up files that are at least 1 hour old.

To change this, you can specify the following environment variables:

CLEANUP_CRON: A cron string to specify when the cleanup task is run

TTL: The cutoff age (in milliseconds) for files to be deleted

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.