CrisFeit / vtex-email-framework

Transactional Emails Development Architecture

VTEX Email Framework

Transactional emails development architecture

📦 Setup

npx create-vtex-email my-emails

🎮 Commands

npm	yarn
npm run dev	yarn dev
npm run build	yarn build

⚔️ Features

• Sass
• Hot Reload
• Partial Files
• Inline CSS
• Dashboard
• Render Test
• Email Stylelint
• Responsive Boilerplate

🗺️ Guide

• Data and template file name must be the same

emails
│
└───json
│   │   order-confirmation.json
│   │   payment-approved.json
└───templates
    │   order-confirmation.hbs
    │   payment-approved.hbs
    └───partials
        │   Header.hbs
        │   Cart.hbs

• Partials import

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

📚 References

BEM

Sass

Handlebars

Can I Email

Emails Support