{"id":28963395,"url":"https://github.com/crisfeit/vtex-email-framework","last_synced_at":"2025-06-24T04:09:44.396Z","repository":{"id":46219298,"uuid":"326277625","full_name":"CrisFeit/vtex-email-framework","owner":"CrisFeit","description":"Transactional  Emails Development Architecture","archived":false,"fork":false,"pushed_at":"2024-12-14T14:43:48.000Z","size":556,"stargazers_count":25,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"v4","last_synced_at":"2025-06-20T00:18:03.413Z","etag":null,"topics":["email","email-framework","email-template","emails","framework","handlebars","vtex"],"latest_commit_sha":null,"homepage":"","language":"Handlebars","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CrisFeit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-02T21:52:05.000Z","updated_at":"2024-12-14T14:43:52.000Z","dependencies_parsed_at":"2024-07-26T19:22:59.127Z","dependency_job_id":"dbc2221b-8245-4edb-a9e1-fa39c0f2d5e2","html_url":"https://github.com/CrisFeit/vtex-email-framework","commit_stats":{"total_commits":134,"total_committers":3,"mean_commits":"44.666666666666664","dds":"0.22388059701492535","last_synced_commit":"5d849e9b5155a78be677c9068db95ff76e62d0fd"},"previous_names":[],"tags_count":17,"template":true,"template_full_name":null,"purl":"pkg:github/CrisFeit/vtex-email-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrisFeit%2Fvtex-email-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrisFeit%2Fvtex-email-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrisFeit%2Fvtex-email-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrisFeit%2Fvtex-email-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrisFeit","download_url":"https://codeload.github.com/CrisFeit/vtex-email-framework/tar.gz/refs/heads/v4","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrisFeit%2Fvtex-email-framework/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261510105,"owners_count":23169694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email","email-framework","email-template","emails","framework","handlebars","vtex"],"created_at":"2025-06-24T04:09:43.790Z","updated_at":"2025-06-24T04:09:44.388Z","avatar_url":"https://github.com/CrisFeit.png","language":"Handlebars","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VTEX Email Framework\n\n[![Badge](https://img.shields.io/badge/%20VTEX-%3D?logo=vtex\u0026color=ED125F\u0026label=emails\u0026logoColor=ED125F)](https://help.vtex.com/tutorial/list-of-e-mail-templates-in-the-message-center--3g2S2kqBOoSGcCaqMYK2my) [![Badge](https://img.shields.io/badge/%20handlebars-%3D?logo=handlebars.js\u0026color=f0772b\u0026label=templating\u0026logoColor=f0772b)](https://handlebarsjs.com/) [![Badge](https://img.shields.io/badge/v3%20node.js-%20%3E%3D_14-forestgreen?logo=node.js)](https://nodejs.org) [![Badge](https://img.shields.io/badge/v4%20node.js-%20%3E%3D_20-forestgreen?logo=node.js)](https://nodejs.org) [![Badge](https://img.shields.io/npm/dm/vtex-email-framework?color=%23CB3837\u0026logo=npm)](https://www.npmjs.com/package/vtex-email-framework)\n\n## Transactional emails development architecture\n\n### 📦 Setup\n\n```bash\nnpx create-vtex-email my-emails\n```\n\n### 🎮 Commands\n\n| npm | yarn | pnpm |\n| ----------- | --- | --- |\n|`npm run dev` | `yarn dev`| `pnpm run dev`|\n|`npm run build` | `yarn build`| `pnpm run build`|\n\n### ⚔️ Features\n\n* Sass\n* Hot Reload\n* Partial Files\n* Inline CSS\n* Dashboard\n* Render Test\n* Email Stylelint\n* Responsive Boilerplate\n\n### 🗺️ Guide\n\n* Data and template file name must be the same\n\n```javascript\nemails\n│\n└───json\n│   │   order-confirmation.json\n│   │   payment-approved.json\n└───templates\n    │   order-confirmation.hbs\n    │   payment-approved.hbs\n    └───partials\n        │   Header.hbs\n        │   Cart.hbs\n```\n\n* Partials import\n\n```handlebars\n\u003cHeader class=\"partial\"\u003e{{\u003e Header}}\u003c/Header\u003e\n```\n\n### 📚 References\n\n[BEM](http://getbem.com/naming/)\n\n[Sass](https://sass-lang.com/guide)\n\n[Handlebars](https://handlebarsjs.com/)  \n\n[Can I Email](https://www.caniemail.com/)\n\n[Emails Support](https://www.campaignmonitor.com/css/)  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrisfeit%2Fvtex-email-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrisfeit%2Fvtex-email-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrisfeit%2Fvtex-email-framework/lists"}