@jemjar/emails v2.4.1

JEMJAR EMAILS

DEVELOPMENT

In order to ease development, there is a gulp file with many tasks. For template development, most likely you'll just need to run:

gulp

The default gulp does the following

• Render all templates
• Start a server at http://localhost:8080 where all emails will be available in the browser
• Re-render the appropriate email when the main email file is edited
• Re-render all templates when a block is edited

On re-rendering, the browser will refresh automatically.

NOTE FOR DEVELOPERS USING WINDOWS

You need to either:

• install ts-node globally
• find a way to make ts-node work as a local command (node_modules/.bin/ts-node) and change gulpfile.js

HOW TO ADD NEW ILLUSTRATION

1. Add a new illustration to .\static\ folder
2. Add new url variable in .\static\urls.ts file
3. Include new url variable to an email template
4. Re-run gulp in order to see the illustration in the browser

Illustrations update automatically on s3 bucket on deployment.

.NJK FORMATTING

• Install a plugin for your code editor to format .njk files
• Apply formatting rules from .njkformat file

For VS Code:

• Install jkformat - https://marketplace.visualstudio.com/items?itemName=jaskang.jkformat
• In the file %USERPROFILE%\.vscode\extensions\jaskang.jkformat-1.0.6\out\src\beautify\index.js (for Windows) change value of unformatted prop in args object in a function beatify() from true to false (to prevent case changing of a template's variables inside html tags)
• Copy settings from .njkformat file to your Workspace settings

{
	"settings": {
		"jkformat": {
			// Paste your .njk formatting rules from .njkformat file here
		}
	},
}

• Open .njk file and run jkformat command to format your code
• If you want to update .njkformat see default settings in %USERPROFILE%\.vscode\extensions\jaskang.jkformat-1.0.6\out\src\beautify\options.js (for Windows)