31 lines
909 B
Markdown
31 lines
909 B
Markdown
# @lfk/document-server
|
|
|
|
The document generation server responsible for creating pdfs for sponsoring contracts, certificates and more.
|
|
|
|
## Quickstart 🐳
|
|
> 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`
|
|
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
|
|
```bash
|
|
yarn
|
|
```
|
|
3. Start the server
|
|
```bash
|
|
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. |