document-server/README.md

@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

   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.

Recommended Editor

Visual Studio Code

Recommended Extensions

• will be automatically recommended via ./vscode/extensions.json

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