Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snics/email-templates-effe
An alternative engine for email-templates and adding support for Foundation for Emails :email::mailbox::rocket:
https://github.com/snics/email-templates-effe
alternative email email-template engine foundation-for-emails
Last synced: 2 days ago
JSON representation
An alternative engine for email-templates and adding support for Foundation for Emails :email::mailbox::rocket:
- Host: GitHub
- URL: https://github.com/snics/email-templates-effe
- Owner: snics
- License: mit
- Created: 2018-05-07T16:38:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-13T01:50:04.000Z (about 6 years ago)
- Last Synced: 2024-08-09T13:43:36.488Z (3 months ago)
- Topics: alternative, email, email-template, engine, foundation-for-emails
- Language: JavaScript
- Homepage:
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# email-templates-effe
[](https://badge.fury.io/js/email-templates-effe)
[](https://travis-ci.org/snics/email-templates-effe)
[](https://coveralls.io/github/snics/email-templates-effe?branch=master)
[](https://david-dm.org/snics/email-templates-effe)
[](https://david-dm.org/snics/email-templates-effe?type=dev)
[](https://github.com/snics/email-templates-effe/blob/master/LICENSE)
> Email-templates-effe is an alternative engine for [email-templates](https://github.com/niftylettuce/email-templates) and add support for [Foundation for Emails](https://foundation.zurb.com/emails.html) :email::mailbox::rocket:
### Dependencies
- [Node.js](https://nodejs.org/en/) (requires Angular 6 or higher, tested with v6, v8, v9 and v10)
### Installing
install `email-templates-effe` via npm:
```shell
npm install email-templates-effe --save
```
Or via yarn
```shell
yarn add email-templates-effe
```
### Usage
Once installed you need to import the module and set up the root directory for handlebars:
```javascript
const Email = require('email-templates');
const path = require('path');
const engine = require('email-templates-effe');
// Setup
const email = new Email({
views: {
root: path.join(__dirname, 'root/directory/to/all/email/files'),
options: {
extension: 'hbs',
engineSource: engine({
root: path.join(__dirname, 'handlebars')
})
}
}
});
// Using email engine:
email
.send({
template: 'hallo',
message: {
to: '[email protected]'
},
locals: {
name: 'John'
}
})
.then(res => {
console.log('res.originalMessage', res.originalMessage)
});
.catch(console.error);
```
Or you can define all handlebars directory manually with `layouts`, `partials` and `helpers`
```javascript
// ...Other Code
// Setup
const email = new Email({
views: {
root: path.join(__dirname, 'root/directory/to/all/email/files'),
options: {
extension: 'hbs',
engineSource: engine({
layouts: path.join(__dirname, 'handlebars/layouts'),
partials: path.join(__dirname, 'handlebars/partials'),
helpers: path.join(__dirname, 'handlebars/helpers')
})
}
}
});
// ...Other Code
```
## Configuration
| configuration option | type | default | description |
|:---------------------|:------:|:-------:|:-----------------------------------------------------------------------------------------------------------------|
| root | string | - | With `root` you can define root directory for handlebars with `layouts`, `partials` and `partials` as suborders. |
| layouts | string | - | With `layouts` you can define an exact handlebars layouts path |
| partials | string | - | With `partials` you can define an exact handlebars partials path |
| partials | string | - | With `partials` you can define an exact handlebars partials path |
## Development
For the development you need Node.js v6 or higher. If you have Node.js installed you can use the following commands to run the test
Using npm:
```shell
npm install
npm run test:lint // Run lint test in watch
npm run test:watch // Run unit test in watch mode
```
or use yarn (yarn must be installed since it is not part of node.js.):
```shell
yarn install
yarn run test:lint // Run lint test in watch
yarn run test:watch // Run unit test in watch mode
```
### Built With
- [bluebird](https://www.npmjs.com/package/bluebird) - Good and fast promise library
- [cheerio](https://www.npmjs.com/package/cheerio) - It's like jQuery for Server
- [front-matter](https://www.npmjs.com/package/front-matter) - Extract meta data from documents.
- [glob](https://www.npmjs.com/package/glob) - Match files using the patterns used by the shell
- [handlebars](https://www.npmjs.com/package/handlebars) - Handlebars is a template engine
- [inky](https://www.npmjs.com/package/inky) - Inky is a template engine for Foundation for Emails tags
- [lodash](https://www.npmjs.com/package/lodash) - A helper library
- [strip-bom](https://www.npmjs.com/package/strip-bom) - Strip UTF-8 byte order mark (BOM) from a string
## Versioning
We use [SemVer](http://semver.org/spec/v2.0.0.html) for versioning. For the versions available, see the [tags on this repository](https://github.com/snics/email-templates-effe/tags).
## Authors
* **Nico Swiatecki** - *Initial work* - [Snics](https://github.com/snics)
See also the list of [contributors](https://github.com/snics/email-templates-effe/graphs/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details