Foundation for Emails Template

Please open all issues with this template on the main Foundation for Emails repo.

This is the official starter project for Foundation for Emails, a framework for creating responsive HTML devices that work in any email client. It has a Gulp-powered build system with these features:

• Handlebars HTML templates with Panini
• Simplified HTML email syntax with Inky
• Sass compilation
• Image compression
• Built-in BrowserSync server
• Full email inlining process

Installation

To use this template, your computer needs Node.js 0.12 or greater. The template can be installed with the Foundation CLI, or downloaded and set up manually.

Using the CLI

Install the Foundation CLI with this command:

npm install foundation-cli --global

Use this command to set up a blank Foundation for Emails project:

foundation new --framework emails

The CLI will prompt you to give your project a name. The template will be downloaded into a folder with this name.

Manual Setup

To manually set up the template, first download it with Git:

git clone [email protected]:play/play-mailing.git

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

cd projectname
npm i

Build Commands

Run npm start to kick off the build process. A new browser tab will open with a server pointing to your project files. (with serve mode)

Run npm run build to inline your CSS into your HTML along with the rest of the build process. (with serve mode)

Run npm run buildhard to inline your CSS into your HTML, delete all classes and create two folders with emails (minEmail 'compressed html', unMinEmail 'uncompressed html') along with the rest of the build process (no serve mode).