Skip to content

CrisFeit/vtex-email-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VTEX Email Framework

Badge Badge Badge Badge Badge

Transactional emails development architecture

📦 Setup

npx create-vtex-email my-emails

🎮 Commands

npm yarn pnpm
npm run dev yarn dev pnpm run dev
npm run build yarn build pnpm run 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