MJML development environment for building e-mail templates

Перейти к файлу

Dimitrie Stefanescu f1ccb97de4 fix: properly adding http-server to dev-deps		2022-08-11 10:37:55 +03:00
.github	Merge remote-tracking branch 'template/main' into main	2022-08-09 12:16:23 +03:00
.vscode	removing prettier	2022-08-10 16:33:56 +03:00
.yarn/releases	init commit	2022-08-04 13:02:07 +03:00
assets	finished base template	2022-08-04 14:17:08 +03:00
dist	feat(p): password reset template	2022-08-10 18:07:40 +03:00
src	feat(p): password reset template	2022-08-10 18:07:40 +03:00
.editorconfig	init commit	2022-08-04 13:02:07 +03:00
.gitignore	init commit	2022-08-04 13:02:07 +03:00
.yarnrc.yml	init commit	2022-08-04 13:02:07 +03:00
LICENSE	Initial commit	2022-08-04 14:23:12 +03:00
README.md	feat(p): password reset template	2022-08-10 18:07:40 +03:00
SECURITY.md	Add a SECURITY.md file	2022-08-08 10:00:36 +01:00
docker-compose.yml	finished base template	2022-08-04 14:17:08 +03:00
package.json	fix: properly adding http-server to dev-deps	2022-08-11 10:37:55 +03:00
yarn.lock	fix: properly adding http-server to dev-deps	2022-08-11 10:37:55 +03:00

README.md

speckle-email-templates ✉️

Introduction

Uses the MJML framework to build e-mail templates without dealing with a lot of the complexity that often arises out of doing so.

Developing & Debugging

Environment setup

Make sure you have yarn 1.x available globally (e.g. through corepack)

Development

Use VSCode and make sure you install the recommended MJML extension. Through this extension you can will get syntax highlighting in .mjml files and also the option to trigger a live preview right from the specific .mjml file.

Before development do yarn serve:assets to start a local file server. You'll need that to be able to see assets in the preview pane, cause it expects assets to be hosted somewhere and accessed through HTTP, not loaded from a relative path on your PC.

The file server is accessible at localhost:4040, assets are served from /assets and built templates from /templates.

Building

Run yarn build to build everything. Run yarn watch to build in watch mode.

Testing

Sending out email template

You can configure the MJML VSCode extension to actually send out an email of your template. To do so, make sure to configure the mjml.mailjetAPIKey, mjml.mailjetAPISecret and mjml.mailSender settings or mjml.nodemailer settings in your user settings.

Do not save these values into the workspace settings we don't want tokens being commited to Git!

Validating on multiple clients

You can use a trial for one of these kinds of services: https://www.emailonacid.com/. The goal here is to evaluate that the template looks right in different kinds of e-mail clients and their versions.

Contributing

Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.

Community

The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!

Security

For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.