Compare commits
No commits in common. "61bbeb0d8f3fd6bfafb65bd11eb4c076a27b4a53" and "2071c4db33bbb9fd41ef650b409cac789732225f" have entirely different histories.
61bbeb0d8f
...
2071c4db33
30
README.md
30
README.md
@ -35,41 +35,11 @@ yarn test:watch
|
|||||||
yarn test:ci
|
yarn test:ci
|
||||||
```
|
```
|
||||||
|
|
||||||
### Use your own mail templates
|
|
||||||
> You use your own mail templates by replacing the default ones we provided (either in-code or by mounting them into the /app/static/mail_templates folder).
|
|
||||||
|
|
||||||
The mail templates always come in a .html and a .txt variant to provide compatability with legacy mail clients.
|
|
||||||
Currently the following templates exist:
|
|
||||||
* pw-reset.(html/txt)
|
|
||||||
|
|
||||||
### Generate Docs
|
### Generate Docs
|
||||||
```bash
|
```bash
|
||||||
yarn docs
|
yarn docs
|
||||||
```
|
```
|
||||||
|
|
||||||
## 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 (uses [ethereal.email](https://ethereal.email) as the mailserver).
|
|
||||||
|
|
||||||
| 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
|
|
||||||
|
|
||||||
## Recommended Editor
|
## Recommended Editor
|
||||||
|
|
||||||
[Visual Studio Code](https://code.visualstudio.com/)
|
[Visual Studio Code](https://code.visualstudio.com/)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user