Overview

A document generation library, used to generate PDF documents and email templates using React and Puppeteer

Its primarily consumed by @finematter/api

Getting started

Create a file .env.development.local and copy the contents found in 1password

npm i
npm run develop

Releasing

Its published as a private npm package via github actions

Steps to release

1. Select the correct version type major,minor or patch
2. Run the relevant release:* script

npm run release:minor

This will build the distribution, tag and publish to npm The publication will happen from GitHub after some time, you don't need to push to npm manually

Confirm release

You can view the progress in the actions for the repos

Once complete, you can confirm its been released by runnning the following command:

npm view @finematter/document versions

Update any consumers

You're then able to update the relevant consumers of library by running:

npm i @finematter/document@latest

Development

Create a file .env.development.local and copy the contents of to note .env.development.local (document) in 1password

npm i
npm run storybook

Images in emails

To use the Imgix static component you need to upload any interesting images to the path images/emails in the S3 bucket static.finematter.com so they can loaded by Imgix.

You also need to update the permission on the object object to be Everyone (public access) -> Read so it becomes publicly accessible.