From 77040adf86aeec3862be03239cdbbe6ec7041e09 Mon Sep 17 00:00:00 2001 From: Alejandra <90076947+alejsdev@users.noreply.github.com> Date: Sat, 17 Aug 2024 13:59:22 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20Email=20Templates=20to=20`?= =?UTF-8?q?backend/README.md`=20(#1311)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- backend/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/backend/README.md b/backend/README.md index e6400be194..7e7829677f 100644 --- a/backend/README.md +++ b/backend/README.md @@ -196,3 +196,11 @@ $ alembic upgrade head ``` If you don't want to start with the default models and want to remove them / modify them, from the beginning, without having any previous revision, you can remove the revision files (`.py` Python files) under `./backend/app/alembic/versions/`. And then create a first migration as described above. + +## Email Templates + +The email templates are in `./backend/app/email-templates/`. Here, there are two directories: `build` and `src`. The `src` directory contains the source files that are used to build the final email templates. The `build` directory contains the final email templates that are used by the application. + +Before continuing, ensure you have the [MJML extension](https://marketplace.visualstudio.com/items?itemName=attilabuti.vscode-mjml) installed in your VS Code. + +Once you have the MJML extension installed, you can create a new email template in the `src` directory. After creating the new email template and with the `.mjml` file open in your editor, open the command palette with `Ctrl+Shift+P` and search for `MJML: Export to HTML`. This will convert the `.mjml` file to a `.html` file and now you can save it in the build directory.