lfk
/
document-server
2
0
Fork 0
Code Issues Pull Requests Projects Releases 13 Wiki Activity

Typos 

ref #6
This commit is contained in:
Nicolai Ort 2021-02-03 18:06:13 +01:00
parent 8141269dd9
commit 68e34a9054
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -8,7 +8,7 @@ The basic generation mechanism makes the templates and routes interchangeable (i
> Use this to run the document server in docker.
1. Clone the repo or copy the docker-compose
2. Run in toe folder that contains the docker-compose file: `docker-compose up -d`
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 🛠
@ -36,7 +36,7 @@ The basic generation mechanism makes the templates and routes interchangeable (i
> 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 uses for the ["Lauf für Kaya!" charity run](https://lauf-fuer-kaya.de).
We provide a set of default templates that we use for the ["Lauf für Kaya!" charity run](https://lauf-fuer-kaya.de).
We use mustache-style templating strings to fill the templates with real information (exact strings are explained below).
You can provide your own templates by replaceing the ones we provided before compiling the project or by simply mounting your custom templates into the docker container.
@ -45,7 +45,7 @@ The server currently needs the following templates to work:
### Sponsoring Contracts
|Template String | Type | Optional | Description
| Template String | Type | Optional | Description
| runner_firstname | string | ❌ | The runner's first name
| runner_middlename | string | ✅ | The runner's middle name
| runner_lastname | string | ❌ | The runner's last name