https://github.com/leancodepl/pdf-generator
https://github.com/leancodepl/pdf-generator
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/leancodepl/pdf-generator
- Owner: leancodepl
- License: apache-2.0
- Created: 2021-11-15T11:04:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-26T07:53:36.000Z (4 months ago)
- Last Synced: 2026-02-26T12:47:26.494Z (4 months ago)
- Language: TypeScript
- Size: 4.95 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# pdf-generator
This project was generated using [Nx](https://nx.dev).
### [pdf-renderer](packages/pdf-renderer)
NestJS module used for creating PDF files out of react components.
### [invoice-template](packages/invoice-template)
Invoice templates created with react, can be used with pdf-renderer.
### [api-proxy](packages/api-proxy)
Used for authentication and communication with a [contractsgenerator](https://github.com/leancodepl/contractsgenerator)
based api.
### Dockerfile
At the top of your own Dockerfile add the following line.
`FROM ghcr.io/leancodepl/pdf-generator:[version]`
You can also easily get the current version, by using `latest`.
`FROM ghcr.io/leancodepl/pdf-generator:latest`
### Releasing packages to npm
To release a new version, run the following command:
```bash
npx nx run workspace:version --releaseAs=major
# or
npx nx run workspace:version --releaseAs=minor
# or
npx nx run workspace:version --releaseAs=patch
```
This will create a new commit and tag. Push the changes and the new tag to the remote repository. The tag's push will trigger the workflow.
### Releasing the dockerfile
To release the dockerfile, push a new tag with the prefix `docker-`, e.g.:
```bash
git tag docker-v0.1.0
git push origin docker-v0.1.0
```
This will trigger the workflow and push the new docker image to the Azure Container Registry.