Getting Started

Installation

Install NextReport Engine and verify your setup in under two minutes.

Requirements

  • Node.js >= 22 (LTS recommended)
  • npm, pnpm, or yarn package manager

Install the engine

Choose your preferred package manager:

# npm
npm install @nextreport/engine

# pnpm
pnpm add @nextreport/engine

# yarn
yarn add @nextreport/engine

Verify the installation

Create a quick test to confirm everything is wired up correctly:

import { validateReport } from '@nextreport/engine'

const result = validateReport({
  version: '1.0',
  type: 'report',
  page: { size: 'A4', orientation: 'portrait' },
  bands: [],
})

console.log(result)
// { valid: true, errors: [], warnings: [] }

If you see valid: true, you are ready to build your first report.

Optional: PDF rendering

To generate PDF output, install Puppeteer alongside the engine:

npm install puppeteer

Puppeteer ships with a bundled Chromium binary. In containerized environments, see the Docker guide for headless Chromium configuration.

Next steps