{"id":16354661,"url":"https://github.com/peter-neumann-dev/mjml-email-starter","last_synced_at":"2025-08-01T06:39:33.850Z","repository":{"id":237760552,"uuid":"795053155","full_name":"peter-neumann-dev/mjml-email-starter","owner":"peter-neumann-dev","description":"An email templating starter package using MJML for templating and Vite for development.","archived":false,"fork":false,"pushed_at":"2024-05-10T09:15:21.000Z","size":62,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-29T03:49:35.420Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peter-neumann-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2024-05-02T13:45:30.000Z","updated_at":"2024-05-16T07:28:04.000Z","dependencies_parsed_at":"2024-05-10T10:29:43.025Z","dependency_job_id":"f77efec0-b3c9-48a5-9bbf-f3cd459ffe4c","html_url":"https://github.com/peter-neumann-dev/mjml-email-starter","commit_stats":null,"previous_names":["peter-neumann-dev/mjml-email-starter"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-neumann-dev%2Fmjml-email-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-neumann-dev%2Fmjml-email-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-neumann-dev%2Fmjml-email-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-neumann-dev%2Fmjml-email-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peter-neumann-dev","download_url":"https://codeload.github.com/peter-neumann-dev/mjml-email-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239650892,"owners_count":19674835,"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":[],"created_at":"2024-10-11T01:36:19.098Z","updated_at":"2025-02-19T11:44:50.494Z","avatar_url":"https://github.com/peter-neumann-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# mjml. Email Starter Package\n\n[![mjml.](https://img.shields.io/badge/mjml.-4-FF7F00?style=flat-square)](https://mjml.io/)\n[![Vite](https://img.shields.io/badge/Vite-5-646CFF?style=flat-square\u0026logo=vite\u0026logoColor=white)](https://vitejs.dev/)\n[![TypeScript](https://img.shields.io/badge/TypeScript-5-3178C6?style=flat-square\u0026logo=typescript\u0026logoColor=white)](https://www.typescriptlang.org/)\n[![Node.js](https://img.shields.io/badge/Node.js-20-339933?style=flat-square\u0026logo=nodedotjs\u0026logoColor=white)](https://nodejs.org/)\n[![NPM](https://img.shields.io/badge/NPM-8-CB3837?style=flat-square\u0026logo=npm\u0026logoColor=white)](https://www.npmjs.com/)\n\n![Preview](preview.png)\n\n\u003c/div\u003e\n\n## 📖 About\n\nAn email templating starter package using [mjml.](https://mjml.io/) for templating and [Vite](https://vitejs.dev/) for development.\n\n**Useful resources:**\n\n- [mjml. Documentation](https://mjml.io/documentation/)\n- [Can I email](https://www.caniemail.com/)\n- [Litmus Email Testing (paid)](https://www.litmus.com/email-testing)\n\n### 🔧 Requirements\n\n**Node.js 20 installed on your machine**\n\nSee [Node.js](https://nodejs.org/) or preferably use [NVM (Node Version manager)](https://github.com/nvm-sh/nvm)\n\n## 🚀 Quick Start\n\nInstall Node.js dependencies\n\n```bash\nnpm i\n```\n\nStart the development server and mjml. watcher (typically on [localhost:5173](http://localhost:5173))\n\n```bash\nnpm run dev\n```\n\nStart templating your email in the `src` directory.\n\n## 📦 Build\n\nBuild the email template to the `dist` directory\n\n```bash\nnpm run build\n```\n\nPreview the email build in the browser\n\n```bash\nnpm run preview\n```\n\n## 🧰 Tools\n\nRun the TypeScript test\n\n```bash\nnpm run test\n```\n\nFormat code with Prettier\n\n```bash\nnpm run format\n```\n\nTo allow Prettier to format your code on save, configure your editor:\u003cbr\u003e\n[Prettier Editor Integration](https://prettier.io/docs/en/editors)\n\nℹ️ **Ensure to include `.mjml` files in your editor's Prettier configuration**\n\n## 📤 Sending Test Emails with SMTP\n\nIt is possible to send test emails of a build. It requires to set up a `.env` according to the `.env.example` file.\n\n```bash\ncp .env.example .env\n```\n\n**Fill in the required SMTP credentials, and email addresses.**\n\nThen run the following command to send a test email:\n\n```bash\nnpm run send:mail\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeter-neumann-dev%2Fmjml-email-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeter-neumann-dev%2Fmjml-email-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeter-neumann-dev%2Fmjml-email-starter/lists"}