From 4cdba8bc77ce543f6fb636711b8728bce794eac7 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Thu, 2 Feb 2023 12:56:23 +0100 Subject: [PATCH] Updated readme --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 06a44b1..dcb7734 100644 --- a/README.md +++ b/README.md @@ -51,23 +51,23 @@ yarn docs > You can provide them via .env file or docker env vars. > You can use the `test:ci:generate_env` package script to generate a example env (uses bs data as test server and ignores the errors). -| Name | Type | Default | Description -| - | - | - | - -| APP_PORT | Number | 4010 | The port the backend server listens on. Is optional. -| DB_TYPE | String | N/A | The type of the db u want to use. It has to be supported by typeorm. Possible: `sqlite`, `mysql`, `postgresql` -| DB_HOST | String | N/A | The db's host's ip-address/fqdn or file path for sqlite -| DB_PORT | String | N/A | The db's port -| DB_USER | String | N/A | The user for accessing the db -| DB_PASSWORD | String | N/A | The user's password for accessing the db -| DB_NAME | String | N/A | The db's name -| NODE_ENV | String | dev | The apps env - influences debug info. Also when the env is set to "test", mailing errors get ignored. -| POSTALCODE_COUNTRYCODE | String/CountryCode | N/A | The countrycode used to validate address's postal codes -| PHONE_COUNTRYCODE | String/CountryCode | null (international) | The countrycode used to validate phone numers -| SEED_TEST_DATA | Boolean | False | If you want the app to seed some example data set this to true -| MAILER_URL | String(Url) | N/A | The mailer's base url (no trailing slash) -| MAILER_KEY | String | N/A | The mailer's api key. -| IMPRINT_URL | String(Url) | /imprint | The link to a imprint page for the system (Defaults to the frontend's imprint) -| PRIVACY_URL | String(Url) | /privacy | The link to a privacy page for the system (Defaults to the frontend's privacy page) +| Name | Type | Default | Description | +| ---------------------- | ------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------- | +| APP_PORT | Number | 4010 | The port the backend server listens on. Is optional. | +| DB_TYPE | String | N/A | The type of the db u want to use. It has to be supported by typeorm. Possible: `sqlite`, `mysql`, `postgresql` | +| DB_HOST | String | N/A | The db's host's ip-address/fqdn or file path for sqlite | +| DB_PORT | String | N/A | The db's port | +| DB_USER | String | N/A | The user for accessing the db | +| DB_PASSWORD | String | N/A | The user's password for accessing the db | +| DB_NAME | String | N/A | The db's name | +| NODE_ENV | String | dev | The apps env - influences debug info. Also when the env is set to "test", mailing errors get ignored. | +| POSTALCODE_COUNTRYCODE | String/CountryCode | N/A | The countrycode used to validate address's postal codes | +| PHONE_COUNTRYCODE | String/CountryCode | null (international) | The countrycode used to validate phone numers | +| SEED_TEST_DATA | Boolean | False | If you want the app to seed some example data set this to true | +| MAILER_URL | String(Url) | N/A | The mailer's base url (no trailing slash) | +| MAILER_KEY | String | N/A | The mailer's api key. | +| IMPRINT_URL | String(Url) | /imprint | The link to a imprint page for the system (Defaults to the frontend's imprint) | +| PRIVACY_URL | String(Url) | /privacy | The link to a privacy page for the system (Defaults to the frontend's privacy page) | ## Recommended Editor @@ -85,8 +85,8 @@ yarn docs * 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 + * New releases get created as tags from this * 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