From b5018eb11492884db9f4ec969c767c3cce53f105 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 26 Jan 2021 20:26:25 +0100 Subject: [PATCH 1/5] Added the basics about mail templates to the readme ref #123 --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 985a69f..2a11665 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,13 @@ yarn test:watch 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 ```bash yarn docs From 13ccab5e289d0a629cefb7fe281a85a46058ae97 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 26 Jan 2021 20:38:53 +0100 Subject: [PATCH 2/5] Added documentation for the env vars ref #123 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 2a11665..0e61fc0 100644 --- a/README.md +++ b/README.md @@ -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 From 1f0c842d9e086456f1ae0f6908e474258a04beb4 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 26 Jan 2021 20:39:38 +0100 Subject: [PATCH 3/5] Table fix ref #123 --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 0e61fc0..f1571e9 100644 --- a/README.md +++ b/README.md @@ -59,24 +59,24 @@ 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. -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 +| 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 From 53fcff77d00fc2b205ada0bcee7bdfe83d94a9f4 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 26 Jan 2021 20:41:08 +0100 Subject: [PATCH 4/5] Added a hint to ethereal.email ref #123 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f1571e9..47f0961 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ 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. +> 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 | - | - | - | - From 583a4bc0dd0de8026bb2eb6a9b0c31f59344e813 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Tue, 26 Jan 2021 20:41:44 +0100 Subject: [PATCH 5/5] Changed order ref #123 --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 47f0961..8d538ea 100644 --- a/README.md +++ b/README.md @@ -47,14 +47,6 @@ Currently the following templates exist: yarn docs ``` -## Recommended Editor - -[Visual Studio Code](https://code.visualstudio.com/) - -### Recommended Extensions - -* 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 (uses [ethereal.email](https://ethereal.email) as the mailserver). @@ -78,6 +70,13 @@ yarn docs | 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 + +[Visual Studio Code](https://code.visualstudio.com/) + +### Recommended Extensions + +* will be automatically recommended via ./vscode/extensions.json ## Staging ### Branches & Tags