talissonf / transactional-mails

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

transactional-mails

Default transactional email templates for E-Com Plus stores

Usage

The @ecomplus/transactional-mails package provides a list of methods 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.

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
• Methods

Developing

1. Clone the repository:

git clone [e-mail]:ecomclub/transactional-mails.git

2. Move to folder and install dependencies:

cd transactional-mails
npm i

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

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 generated documentation:

npm run doc

7. Commit changes following Conventional Commits;

8. Release and publish:

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