If you see a step below that could be improved (or is outdated), please update the instructions. We rarely go through this process ourselves, so your fresh pair of eyes and your recent experience with it, makes you the best candidate to improve them for other users. Thank you!
Make sure you have Node.js version >= 10.
We recommend using nvm: nvm use.
We recommend cloning the repository in a folder dedicated to opencollective projects.
git clone [email protected]:opencollective/opencollective-pdf.git opencollective/pdf
cd opencollective/pdf
npm install
This project requires an access to the Open Collective API. You have two options:
cp .env.staging .envto connect to the Open Collective staging APIcp .env.local .envto connect to the API running locally
If you decide to pick the local strategy, make sure you install and run the opencollective-api project.
To start the service:
npm run dev
- SSL errors
If you get an error like this while trying to generate a PDF:
Error: html-pdf: Unknown Error Auto configuration failed 140673035953984:error:25066067:DSO support routines:DLFCN_LOAD:could not load the shared library:dso_dlfcn.c:185:filename(libssl_conf.so): libssl_conf.so: cannot > open shared object file: No such file or directory 140673035953984:error:25070067:DSO support routines:DSO_load:could not load the shared library:dso_lib.c:244: 140673035953984:error:0E07506E:configuration file routines:MODULE_LOAD_DSO:error loading dso:conf_mod.c:285:module=ssl_conf, path=ssl_conf 140673035953984:error:0E076071:configuration file routines:MODULE_RUN:unknown module name:conf_mod.c:222:module=ssl_conf
Try adding this line to your .env (source):
OPENSSL_CONF=/dev/null
This is the easy way to start developing. Just go to the root URL http://localhost:3002/ to see a list of test pages and click on any of them to load it in the right pane.
The page will auto-refresh everytime a change is made.
If you use this service through local frontend, you will need to add PDF_SERVICE_URL=http://localhost:3002 line to .env. You're ready to go - frontend will pass your authorization token directly to the app.
However this is not practical to develop, you should only use it to debug the bridge between the two services.
This method can be usefull to debug staging or production invoices, or to work with you local development data. It is also the best way if you need to make changes to the graphql queries.
The easier to make it work is to go to /:userSlug/admin/for-developers on the frontend,
generate a personal token, and to add ?personalToken=your_key_here to all your requests.
Tips
- Replace
.htmlby.pdfto see the generated pdf. - Add
?pageFormat=A4withA4orLetterto change page format - Add
?debug=trueto the URL to see verbose data on the document - Add
?raw=trueto disabled HTML sanitazing (useful to debug missing attributes)
Code style? Commit convention? Please check our Contributing guidelines.
TL;DR: we use Prettier and ESLint, we do like great commit messages and clean Git history.
You can run the tests using npm test.
Merging to main branch will auto-deploy the pdf service to Heroku.
