https://github.com/ecomplus/transactional-mails

Default transactional e-mails sent by E-Com Plus stores
https://github.com/ecomplus/transactional-mails

ecommerce ecomplus email-templates transactional-emails

Last synced: 2 months ago
JSON representation

Default transactional e-mails sent by E-Com Plus stores

• Host: GitHub
• URL: https://github.com/ecomplus/transactional-mails
• Owner: ecomplus
• License: mit
• Created: 2018-12-19T16:18:05.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T23:19:57.000Z (3 months ago)
• Last Synced: 2024-10-29T16:25:48.499Z (3 months ago)
• Topics: ecommerce, ecomplus, email-templates, transactional-emails
• Language: EJS
• Homepage: https://developers.e-com.plus/transactional-mails/
• Size: 2.28 MB
• Stars: 0
• Watchers: 3
• Forks: 5
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# transactional-mails

Default transactional email templates for E-Com Plus stores

## Usage

The `@ecomplus/transactional-mails` package provides a

[list of methods](https://developers.e-com.plus/transactional-mails/transactionalMails.html)

to render email templates with received data.

Each method render a specific template, all of them returns

a promise that pass HTML markup on success.

```js

const transactionalMails = require('@ecomplus/transactional-mails')

transactionalMails.templateName(data, lang, themeColor)

  .then(html => {

    // HTML is a string

    console.log(html)

  })

  .catch(err => console.error(err))

```

- [Documentation](https://developers.e-com.plus/transactional-mails/)

- [Methods](https://developers.e-com.plus/transactional-mails/transactionalMails.html)

## Developing

1. Clone the repository:

```bash

git clone [email protected]:ecomclub/transactional-mails.git

```

2. Move to folder and install dependencies:

```bash

cd transactional-mails

npm i

```

3. Run dev server on http://localhost:3000/:

```bash

npm run serve

```

4. Add or edit templates on folders `views` / `scss`

and dictionary on `i18n` folder;

5. New templates must also be added to `src/index` as

exported lib method;

6. Update [jsdoc](https://jsdoc.app/)

generated documentation:

```bash

npm run doc

```

7. Commit changes following

[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/);

8. Release and publish:

```bash

npm run release

git push --follow-tags origin master && npm publish

```