What is Bojler ?
Bojler is an email framework for developing responsive and lightweight email templates 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.
Project documentation ๐
Full project documentation can be found at https://bojler.slicejack.com/.
Quick-start guide ๐
Full getting started guide can be found here.
1. Download
- Download source files or
- Clone the repo:
git clone https://github.com/Slicejack/bojler.git
2. Install node packages: npm install
Secondly, install node packages in root of your newly downloaded folder with npm install command.
This is an example of what you should get after you run
npm installcommand.
3. Start development server: npm start
Let's fire up our development server
Run npm start in your project root folder.
While your development server is running, every time you make and save changes they will be automatically compiled from src/ to dist/ folder.
This is an example of what you should get after you run
npm startcommand and save some changes while your development server is running.
4. Project configuration and files editing
Youโre ready to edit bojler configuration file in src/sass/_settings.scss.
You can take a deeper look at documentation section where we examine variables and maps more carefully.
Now, you can start adding HTML templates to src/templates folder.
In /templates folder you can find boilerplate.html and boilerplate-with-hero.html which you can use as starting point for new templates.
Available NPM commands
| Command | Description |
|---|---|
npm start |
This command starts live development server and watch task. While your development server is running, every time you make and save changes they will be automatically compiled from src/ to dist/ folder. Take a look at example here. |
npm run build |
This command builds everything from src/ to dist/ folder. Take a look at example here. |
npm run assets |
This command copies all the assets from src/assets/ to dist/assets/ folder. You have to run this command every time you add a new asset in order to see changes. Take a look at example here. |
Features
Quick features overview:
- Itโs responsive
๐ฅ๏ธ ๐ป ๐ฑ - Built with SASS
๐ - Automated SASS to CSS transpiler
๐ข ๐ ๐ - Automated SASS linter (With email development rules)
๐๏ธ - Automated CSS inlining
๐ข ๐ ๐ฆ - Webserver with live reload
๐ - Default boilerplate template included
- Reset styles
- Typography
โ๏ธ - Grid system
- Utility classes
๐ ๏ธ - Components
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:
- Ian Hoar
- Sean Powell
- James White
- Campaign Monitor
- MailChimp
- Email on Acid
- Litmus
- Bringinteraktiv
- Zurb Foundation
License
All contents of this boilerplate are licensed under the MIT license.