hempel v0.1.4

Hempel

Email templates library

Introduction

This is just a simple repository to be the source of truth of all email templates used in all environments. This maintains the html version that is synced to all environments. This uses mjml as the email template library.

How to update

Under src/templates folder, there is a config.json file where you have an array of the templates and the html files for the actual content. It looks something like this

[
    {
        "template": "forgot-password",
        "file": "forgot-password.html",
        "values": "firstName,email"
    },
    {
        "template": "verify-email",
        "file": "verify-email.html",
        "values": "firstName,lastName,email"
    }
]

template is the template code.

file is the filename of the html content where it has the placeholders to be replaced (e.g. {firstName}).

values are the comma-separated placeholders that can be chaned in a template.

How to deploy

Create a feature branch from master and put your updates there (including the templates, etc.). Once done, PR it to master and if it passed review and automated tests, you can create a tag to deploy it to staging and production.