https://github.com/jpagano/mjml-starter-base

Email templating with Gulp, MJML, Nunjucks and BrowserSync
https://github.com/jpagano/mjml-starter-base

browsersync gulp mjml node nunjucks yaml

Last synced: 4 months ago
JSON representation

Email templating with Gulp, MJML, Nunjucks and BrowserSync

• Host: GitHub
• URL: https://github.com/jpagano/mjml-starter-base
• Owner: jpagano
• License: mit
• Created: 2017-07-29T18:52:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T07:28:25.000Z (about 2 years ago)
• Last Synced: 2023-02-26T23:47:11.841Z (almost 2 years ago)
• Topics: browsersync, gulp, mjml, node, nunjucks, yaml
• Language: JavaScript
• Homepage:
• Size: 452 KB
• Stars: 16
• Watchers: 2
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# MJML Starter Base

## Introduction

Starter base for Email templating with Gulp, MJML and Nunjucks. It has a Gulp-powered build system with these features:

- [MJML](https://mjml.io/) engine

- Partials and templates with [Nunjucks](https://mozilla.github.io/nunjucks/)

- Inject data with YAML

- Built-in BrowserSync server

- MJML default templates (Basic and Newsletter)

## Installation

### Requirements

- [NodeJS](https://nodejs.org/en/) (6 or greater)

- [Git](https://git-scm.com/)

Now clone this repository

```bash

git clone https://github.com/jpagano/mjml-starter-base mjml-starter-base

```

Then open the folder in your command line, and install the needed dependencies:

```bash

cd mjml-starter-base

npm install

```

## Usage

Finally, run npm start to run Gulp. Your finished templates will be created in a folder called dist, viewables at this URL:

```bash

npm start

```

```bash

http://localhost:8000

```

## TODO

- [ ] HTML minifier and beautifier

- [ ] Image compression