npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ruanitto/adonis-report-builder

v1.0.3

Published

Report Builder for Adonis 4. Builds a PDF from view

Downloads

18

Readme

Simple Adonis 4 Report Builder

Installation

First, you need to install the wkhtmltopdf command line tool on your system.

The easiest way to do this is to download a prebuilt version for your system. DO NOT try to use the packages provided by your distribution as they may not be using a patched Qt and have missing features.

Finally, to install the node module, use npm:

adonis install @ruanitto/adonis-report-builder

Be sure the wkhtmltopdf command line tool is in your PATH when you're done installing.

Setup

Make sure to read instructions.md on how to set up.

Registering provider

Make sure to register the provider inside start/app.js file.

const providers = [
  '@ruanitto/adonis-report-builder/providers/ReportBuilder'
]

That's all! Now you can use the provider by pulling it from IoC container

const ReportBuilder = use('ReportBuilder')

// Load and render an view
await ReportBuilder.loadView('VIEW_FROM_RESOURCE_PATH', dataToRender)

// Load and render an HTML String
await ReportBuilder.loadHTML('<h1>Hello World!</h1>')

// Result in base64
const stringResult = await ReportBuilder.outputBase64()

// Result in buffer
const bufferResult = await ReportBuilder.outputBuffer()

// Output to file
await ReportBuilder.outputToFile('PATH_TO_SAVE')

Config

The config file is saved as config/reportbuilder.js. Make sure to tweak it as per your needs.

Env variables

The ReportBuilder provider relies on following Env variables. For more details or options configurations see : https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

REPORT_PAGE_SIZE =
REPORT_PAGE_ORIENTATION =
REPORT_FOOTER_FONT_SIZE =
REPORT_FOOTER_RIGHT = 
REPORT_FOOTER_LEFT = 
REPORT_MARGIN_BOTTOM = 
REPORT_MARGIN_LEFT = 
REPORT_MARGIN_RIGHT = 
REPORT_MARGIN_TOP =