parent
b5018eb114
commit
13ccab5e28
24
README.md
24
README.md
@ -55,6 +55,30 @@ yarn docs
|
|||||||
|
|
||||||
* will be automatically recommended via ./vscode/extensions.json
|
* 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
|
## Staging
|
||||||
### Branches & Tags
|
### Branches & Tags
|
||||||
* vX.Y.Z: Release tags created from the main branch
|
* vX.Y.Z: Release tags created from the main branch
|
||||||
|
Loading…
x
Reference in New Issue
Block a user