lfk
/
document-server
2
0
Fork 0
Code Issues Pull Requests Projects Releases 13 Wiki Activity
The document generation server responsible for creating pdfs for sponsoring contracts, certificates and more.
109 Commits 3 Branches 16 Tags 1.9 MiB
JavaScript 77.4%
CSS 12.4%
HTML 6.1%
TypeScript 4%
Go to file
Nicolai Ort 1e67672ef0 Added translation sorting secript 
ref #
 		2021-02-07 12:55:24 +01:00
.vscode Added first parts of template 2021-02-06 19:16:45 +01:00
src Removed base64 image 2021-02-07 12:32:54 +01:00
.drone.yml Added drone file 2021-01-30 18:05:37 +01:00
.gitignore Now with workin i18n-ally config🥳 2021-02-05 22:19:47 +01:00
CHANGELOG.md 🧾New changelog file version [CI SKIP] [skip ci] 2021-02-03 18:21:01 +01:00
Dockerfile Added dockerfile and docker-compose 2021-01-30 17:50:09 +01:00
LICENSE Initial commit 2021-01-27 17:40:34 +00:00
README.md Updated readme 2021-02-05 22:23:48 +01:00
docker-compose.yml Added dockerfile and docker-compose 2021-01-30 17:50:09 +01:00
licenses.md 📖New license file version [CI SKIP] [skip ci] 2021-02-03 17:02:45 +00:00
package.json Added translation sorting secript 2021-02-07 12:55:24 +01:00
sort_translations.js Added translation sorting secript 2021-02-07 12:55:24 +01:00
tsconfig.json Added tsconfig 2021-01-30 17:22:17 +01:00

README.md

@lfk/document-server

The document generation server responsible for creating pdfs for sponsoring contracts, certificates and more. This server doesn't interact with any database and can therefor be deployed on it's own. The basic generation mechanism makes the templates and routes interchangeable (if you want to expand or modify it).

Quickstart 🐳

Use this to run the document server in docker.

  1. Clone the repo or copy the docker-compose
  2. Run in the folder that contains the docker-compose file: docker-compose up -d
  3. Visit http://127.0.0.1:4010/docs to check if the server is running

Dev Setup 🛠

Local dev setup

  1. Rename the .env.example file to .env (you can adjust app port and other settings, if needed)
  2. Install Dependencies 
    yarn
  3. Start the server 
    yarn dev

ENV Vars

You can provide them via .env file or docker env vars.

Name Type Default Description
APP_PORT Number 4010 The port the backend server listens on. Is optional.
NODE_ENV String dev The apps env - influences debug info.

Templates

The document server uses html templates to generate various pdf documents. The templates are stored in src/templates by default.

We provide a set of default templates that we use for the "Lauf für Kaya!" charity run. We use handlebars for templateing utilizing i18next for translation - the i18n string format in the templates is : {{__ "string"}} You can provide your own templates by replacing the ones we provided before compiling the project or by simply mounting your custom templates into the docker container.

The server currently needs the following templates to work:

  • sponsoring_contract.html

Sponsoring Contracts

Template Data Type Optional Description
runners array(Runner) ❌ The runner objects. We generate a contract for each runner on a new DIN-A5 page.

Recommended Editor

Visual Studio Code

Recommended Extensions

  • will be automatically recommended via ./vscode/extensions.json
  • we also provide a config for i18n-ally in the .vscode folder

Staging

Branches & Tags

  • vX.Y.Z: Release tags created from the main branch
    • The version numbers follow the semver standard
    • A new release tag automaticly triggers the release ci pipeline
  • main: Protected "release" branch
    • The latest tag of the docker image get's build from this
    • New releases get created as tags from this
  • dev: Current dev branch for merging the different feature branches and bugfixes
    • The dev tag of the docker image get's build from this
    • Only push minor changes to this branch!
    • To merge a feature branch into this please create a pull request
  • feature/xyz: Feature branches - nameing scheme: feature/issueid-title
  • bugfix/xyz: Branches for bugfixes - nameing scheme:bugfix/issueid-title