{"id":21835792,"url":"https://github.com/vtex/vtex-emails","last_synced_at":"2025-07-04T11:06:00.634Z","repository":{"id":28238517,"uuid":"117623201","full_name":"vtex/vtex-emails","owner":"vtex","description":"Email framework for developing transactional email templates for VTEX E-commerces","archived":false,"fork":false,"pushed_at":"2023-04-20T04:28:13.000Z","size":726,"stargazers_count":36,"open_issues_count":16,"forks_count":28,"subscribers_count":150,"default_branch":"master","last_synced_at":"2025-06-12T02:05:31.511Z","etag":null,"topics":["xp-post-purchase"],"latest_commit_sha":null,"homepage":null,"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/vtex.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":"2018-01-16T02:56:30.000Z","updated_at":"2025-03-10T14:43:58.000Z","dependencies_parsed_at":"2024-11-27T20:36:31.423Z","dependency_job_id":null,"html_url":"https://github.com/vtex/vtex-emails","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vtex/vtex-emails","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fvtex-emails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fvtex-emails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fvtex-emails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fvtex-emails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex","download_url":"https://codeload.github.com/vtex/vtex-emails/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fvtex-emails/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263499193,"owners_count":23476021,"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":["xp-post-purchase"],"created_at":"2024-11-27T20:24:44.515Z","updated_at":"2025-07-04T11:06:00.606Z","avatar_url":"https://github.com/vtex.png","language":"Handlebars","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VTEX Emails\n\nVTEX Emails is an email framework based on [bojler](https://github.com/Slicejack/bojler) for developing transactional email templates for VTEX E-commerces.\n\n## Features\n\nVTEX Emails inherited [Bojler's features](https://github.com/Slicejack/bojler#features) like:\n\n- SASS support\n- Automatic CSS inlining\n- Embedded CSS\n- Webserver with Live Reload\n- Reset styles\n- Responsive design\n\nAnd it has other important features:\n\n- Handlebars compiling\n- Tachyons integration\n- Partials for code reuse\n- VTEX transactional JSONs examples for preview\n- i18n for internationalization\n\n## Folders and structure\n\n- `public` compiled files for preview\n- `dist` compiled files for exporting\n- `source` working folder\n  - `data` JSON files containing Orders data\n  - `helpers` VTEX's Helpers functions\n  - `locales` i18n files\n  - `sass` styles\n  - `templates` e-mails templates\n    - `partials` e-mails parts\n\n### You must NOT add, change or modify:\n\n- `helpers` you can use only Handlebars and VTEX's Helpers\n\n### You can add, change or modify:\n\n- `data` you can create folders with different JSON examples as well. They must have a real VTEX JSON structure\n- `locales` use your own communication\n- `sass` use your own style\n- `templates` name your templates your own way. **Each template must have a JSON file with the same name.**\n- `partials` use the partials that make sense for you\n\n## Hands on\n\n### Installation\n\n1.  Download or clone VTEX Emails\n2.  Install npm dependencies: run `npm install`\n\n### Developing\n\n0.  Requires node `16.x`\n1.  Run `npm run gulp dev`\n2.  Go to [http://localhost:8000/](http://localhost:8000/)\n3.  Choose the language folder and open the template that you want to preview\n\n### Generating an exportable VTEX template\n\n1.  Run `npm run gulp dist`\n2.  Go to `dist` folder, copy the template content and paste it in VTEX Message Center\n\n### Generating a light preview version for testing\n\n1.  Run `npm run gulp preview`\n2.  Go to `public` folder, copy the template content and test it using services like MailChimp\n\n### Changing JSON data set\n\n1.  Stop npm service\n2.  Create a new folder in `source/data`\n3.  Change `orderJsonToRead` variable in `gulpfile.js` to the new folder name\n4.  Start npm service\n\n## To do\n\n- Live reload is not working very well. Sometimes you need to refresh the page manually\n- Recompiling doesn't work for JSON changes. You'll need to stop npm service and start it again\n- Improve Outlook compatibility\n- Improve VTEX inStore scenarios\n\n## Bugs and feature requests\n\nIf you find a bug or need new feature please open a new issue and we will discuss about it.\n\n**Thank you! :)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fvtex-emails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex%2Fvtex-emails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fvtex-emails/lists"}