Rychillie / vtex-email-framework

VTEX Emails Development Architecture

VTEX Email Framework

Transactional emails development architecture

📫 Homepage

⚔️ Features

• Hot Reload
• Partial Files
• Inline CSS
• Dashboard
• Boilerplate
• Template Engine

🗺️ 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
        │   Shelf.hbs

• Partials

✅ Right

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

❌ Wrong

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

🎮 Commands

• Install

yarn install

• Development

yarn dev

• Production

yarn build

• Test

yarn test

📚 References

BEM

Handlebars

Can I Email

Emails Support

Vtex Templates

Vtex Message Center