lfk
/
backend
2
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 40 Wiki Activity

Added documentation for the env vars 

ref #123
This commit is contained in:
Nicolai Ort 2021-01-26 20:38:53 +01:00
parent b5018eb114
commit 13ccab5e28
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -55,6 +55,30 @@ yarn docs
* will be automatically recommended via ./vscode/extensions.json
## ENV Vars
> 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.
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.
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
MAIL_SERVER | String | N/A | The smtp server's ip-address/fqdn
MAIL_PORT | String | N/A | The smtp server's port
MAIL_USER | String | N/A | The username for sending mails
MAIL_PASSWORD | String | N/A | The user's password for sending mails
MAIL_FROM | String | N/A | The from-address for sending mails
## Staging
### Branches & Tags
* vX.Y.Z: Release tags created from the main branch