isneezy/pdf-generator repository overview

⁠@isneezy/pdf-generator-service

@isneezy/pdf-generator-service is a web service that allows you to easily generate PDFs from a web interface. It uses the @isneezy/pdf-generator⁠ library to generate the PDFs and provides an HTTP API that you can use to generate PDFs from a web application.

The package is available in three forms:

• as a command line interface
• as a container image

⁠Installation

⁠Command Line Interface

You can install the package as a command line interface using npm or yarn.

npm install -g @isneezy/pdf-generator-service

yarn global add @isneezy/pdf-generator-service

⁠Container Image

The package is also available as a container image on quay.io⁠. It's suggested to check the available tags here⁠ before pulling the image.

To run the service in a container, you can use the docker run command and specify the necessary environment variables and ports.

For example:

docker run -p 3000:3000 quay.io/isneezy/pdf-generator-service

This command will start the service and make it accessible on port 3000.

⁠Usage

⁠Command Line Interface

To start the service, you can use the pdf-generator-service command.

pdf-generator-service [options]

It's important to note that when using the container image, the options should be passed as environment variables.

⁠HTTP API

The service exposes a single endpoint: POST /v1/generate.

You can use this endpoint to generate a PDF by making a POST request with the following options as the request body.