Skip to content

Latest commit

 

History

History
110 lines (88 loc) · 5.71 KB

README.md

File metadata and controls

110 lines (88 loc) · 5.71 KB
Raw

Bojler Heading

GitHub release Travis Github All Releases GitHub code size in bytes GitHub issues GitHub closed issues license

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

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 install command.

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 start command 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:

License

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