{"id":18577391,"url":"https://github.com/ecomplus/transactional-mails","last_synced_at":"2025-04-10T09:30:49.413Z","repository":{"id":38996908,"uuid":"162462258","full_name":"ecomplus/transactional-mails","owner":"ecomplus","description":"Default transactional e-mails sent by E-Com Plus stores","archived":false,"fork":false,"pushed_at":"2025-03-18T00:56:52.000Z","size":2149,"stargazers_count":0,"open_issues_count":9,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T21:40:20.910Z","etag":null,"topics":["ecommerce","ecomplus","email-templates","transactional-emails"],"latest_commit_sha":null,"homepage":"https://developers.e-com.plus/transactional-mails/","language":"EJS","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/ecomplus.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":"2018-12-19T16:18:05.000Z","updated_at":"2024-09-18T23:35:37.000Z","dependencies_parsed_at":"2023-02-15T05:16:38.487Z","dependency_job_id":"1d2e95c5-1225-4e10-9f3f-e8579a1a0a7e","html_url":"https://github.com/ecomplus/transactional-mails","commit_stats":{"total_commits":322,"total_committers":7,"mean_commits":46.0,"dds":0.5559006211180124,"last_synced_commit":"66ae5b62c420f3b016def8c0aa115e62e258e233"},"previous_names":[],"tags_count":74,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Ftransactional-mails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Ftransactional-mails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Ftransactional-mails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Ftransactional-mails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ecomplus","download_url":"https://codeload.github.com/ecomplus/transactional-mails/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247873155,"owners_count":21010400,"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":["ecommerce","ecomplus","email-templates","transactional-emails"],"created_at":"2024-11-06T23:29:00.347Z","updated_at":"2025-04-10T09:30:48.398Z","avatar_url":"https://github.com/ecomplus.png","language":"EJS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# transactional-mails\n\nDefault transactional email templates for E-Com Plus stores\n\n## Usage\n\nThe `@ecomplus/transactional-mails` package provides a\n[list of methods](https://developers.e-com.plus/transactional-mails/transactionalMails.html)\nto render email templates with received data.\n\nEach method render a specific template, all of them returns\na promise that pass HTML markup on success.\n\n```js\nconst transactionalMails = require('@ecomplus/transactional-mails')\n\ntransactionalMails.templateName(data, lang, themeColor)\n  .then(html =\u003e {\n    // HTML is a string\n    console.log(html)\n  })\n  .catch(err =\u003e console.error(err))\n```\n\n- [Documentation](https://developers.e-com.plus/transactional-mails/)\n- [Methods](https://developers.e-com.plus/transactional-mails/transactionalMails.html)\n\n## Developing\n\n1. Clone the repository:\n```bash\ngit clone git@github.com:ecomclub/transactional-mails.git\n```\n\n2. Move to folder and install dependencies:\n```bash\ncd transactional-mails\nnpm i\n```\n\n3. Run dev server on http://localhost:3000/:\n```bash\nnpm run serve\n```\n\n4. Add or edit templates on folders `views` / `scss`\nand dictionary on `i18n` folder;\n\n5. New templates must also be added to `src/index` as\nexported lib method;\n\n6. Update [jsdoc](https://jsdoc.app/)\ngenerated documentation:\n```bash\nnpm run doc\n```\n\n7. Commit changes following\n[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/);\n\n8. Release and publish:\n```bash\nnpm run release\ngit push --follow-tags origin master \u0026\u0026 npm publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomplus%2Ftransactional-mails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fecomplus%2Ftransactional-mails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomplus%2Ftransactional-mails/lists"}