Awesome Open Source
Awesome Open Source

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.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
css (7,240)Β 
framework (1,096)Β 
scss (650)Β 
email (301)Β 
grid (216)Β 
css-framework (121)Β 
templates (111)Β 
utilities (103)Β 
typography (98)Β 
email-template (25)Β 
reset (15)Β 

Find Open Source By Browsing 7,000 Topics Across 59 Categories

Advertising πŸ“¦Β 10
All Projects
Application Programming Interfaces πŸ“¦Β 124
Applications πŸ“¦Β 192
Artificial Intelligence πŸ“¦Β 78
Blockchain πŸ“¦Β 73
Build Tools πŸ“¦Β 113
Cloud Computing πŸ“¦Β 80
Code Quality πŸ“¦Β 28
Collaboration πŸ“¦Β 32
Command Line Interface πŸ“¦Β 49
Community πŸ“¦Β 83
Companies πŸ“¦Β 60
Compilers πŸ“¦Β 63
Computer Science πŸ“¦Β 80
Configuration Management πŸ“¦Β 42
Content Management πŸ“¦Β 175
Control Flow πŸ“¦Β 213
Data Formats πŸ“¦Β 78
Data Processing πŸ“¦Β 276
Data Storage πŸ“¦Β 135
Economics πŸ“¦Β 64
Frameworks πŸ“¦Β 215
Games πŸ“¦Β 129
Graphics πŸ“¦Β 110
Hardware πŸ“¦Β 152
Integrated Development Environments πŸ“¦Β 49
Learning Resources πŸ“¦Β 166
Legal πŸ“¦Β 29
Libraries πŸ“¦Β 129
Lists Of Projects πŸ“¦Β 22
Machine Learning πŸ“¦Β 347
Mapping πŸ“¦Β 64
Marketing πŸ“¦Β 15
Mathematics πŸ“¦Β 55
Media πŸ“¦Β 239
Messaging πŸ“¦Β 98
Networking πŸ“¦Β 315
Operating Systems πŸ“¦Β 89
Operations πŸ“¦Β 121
Package Managers πŸ“¦Β 55
Programming Languages πŸ“¦Β 245
Runtime Environments πŸ“¦Β 100
Science πŸ“¦Β 42
Security πŸ“¦Β 396
Social Media πŸ“¦Β 27
Software Architecture πŸ“¦Β 72
Software Development πŸ“¦Β 72
Software Performance πŸ“¦Β 58
Software Quality πŸ“¦Β 133
Text Editors πŸ“¦Β 49
Text Processing πŸ“¦Β 136
User Interface πŸ“¦Β 330
User Interface Components πŸ“¦Β 514
Version Control πŸ“¦Β 30
Virtualization πŸ“¦Β 71
Web Browsers πŸ“¦Β 42
Web Servers πŸ“¦Β 26
Web User Interface πŸ“¦Β 210