/bojler

Bojler is an email boilerplate and a guideline for writing HTML code that will render correctly across each of the most popular email clients.

Primary LanguageCSSMIT LicenseMIT

bojler

Bojler is an email boilerplate and a guideline for writing HTML code that will render correctly across each of the most popular email clients.

If you have experience with email template development, you know how painful it is to build a perfect email template that works across all email clients.

To make it easier for you to develop responsive and lightweight email templates we have created Bojler.

Old version [v1.0.0] ⚠️

Old version of Bojler can be found here.

Table of contents

Project documentation 📖

Full project documentation can be found at http://slicejack.github.io/bojler/.

Quick-start guide 🚀

  1. Clone the repo: git clone https://github.com/Slicejack/bojler.git
  2. Install node packages: npm install
  3. Create an email with HTML and SASS inside /source directory
  4. Compile an email: npm run gulp
  5. Compress and optimize images
  6. Test email properly
  7. Send email properly 🎉

Full getting started guide can be found here.

Features

Quick features overview:

Bugs and feature requests 🕷️

If you find a bug or need new feature please open a new issue and we will discuss about it.

How to contribute ? 🛠️

You can review the guidelines for contributing to this repository here.

Change Log

All notable changes to this project will be documented in CHANGELOG file.

Credits

Special thanks to:

License

All contents of this boilerplate are licensed under the MIT license.