For creating DI (ITEP) pdfs
This project structure is based on lerna. The APIs & frontends of different pdf projects are different packages with in the same repo.
The pdf-base package contains components that will get re-used by current & future pdf packages. Same applies to the api-base package.
The thought process behind this project structure is to have re-usable atomic packages / components to re-use for all future and current pdf jobs
Goals
- To have ready to go pdf / web templates i.e have re-usable components
- Auto generate pdfs from web page equivalents using puppeteer
- Create static html versions of pdf / web pages for easy insertion into other webapps (workes -- ish)
- Have a modular extensible platform for future re-use
Tools
Installations & setup
npm i -g lerna yarn
npm install # from root
lerna bootstrap # installs externa dependencies
Useful commands
lerna bootstrap # installs all package dependencies
lerna run lint # lints all packages
lerna run build && lerna run start # starts api & pdf front end
lerna run dev # runs packages in dev mode
lerna run build --scope @devinit/pdf-base # running a command in say one package
see lerna repo readme for more.
TODO
- add storybook snapshot testing