Avera123 / vtex-email-framework

Vtex Emails Development Environment

VTEX Email Framework

Development environment setup for VTEX transactional emails

Features

Development

• Sass
• Hot Reload
• Partial Files
• Dashboard
• Boilerplate
• Syntax Highlight
• Template Engine

Production

• Minify css
• Autoprefixer
• Inline styles
• HTML Attributes
• Embedded styles

Requirements

• Node.js >=14

Install

  npm | yarn install

Guide

• Data and template file name must be the same

app
│
└───data
│   │   order-confirmation.json
│   │   payment-aproved.json
└───templates
    │   order-confirmation.hbs
    │   payment-aproved.hbs
    └───partials
        │   Header.hbs
        │   Shelf.hbs

• Partials

<Shelf class="partial">{{> Shelf}}</Shelf>

Comand

• Development

npm | yarn dev

• Production

npm | yarn build

References

Handlebars

Emails Support

Vtex Templates

Vtex Message Center