mirror of
https://github.com/pdfme/pdfme.git
synced 2026-06-16 10:19:20 -04:00
afbfa87674
* Add pdf2img integration for converting PDF to images in e2e tests * Refactor PDF generation tests to convert PDFs to images and validate against snapshots * Refactor package.json files to remove "type": "module" and update import statements to CommonJS format * Fix e2e test * Add new image snapshots for e2e tests and remove obsolete snapshot
This repository is a playground and development environment for the https://github.com/pdfme/pdfme library. It can be started with the following command.
root directory
$ npm install
$ npm run build
playground directory
$ npm install
$ npm run dev
If you are developing a pdfme library, please refer to the following document. https://github.com/pdfme/pdfme/blob/main/DEVELOPMENT.md
How to Add Templates to the List
The playground/public/templates directory contains sample templates, which are used at https://pdfme.com/templates and https://playground.pdfme.com/templates.
Follow these steps to add a sample template:
- Create a directory with a kebab-case name inside
playground/public/templates.- This template name will be converted from kebab-case and displayed in the template selection screen.
- Place a
template.jsonfile inside the directory you created.- You can create this template using https://pdfme.com/template-design or https://playground.pdfme.com.
- At the root of the
playgrounddirectory, run eithernpm run generate-template-assetsornpm run build.- This will generate the template list data and thumbnail images.