Git Product home page Git Product logo

simpleemailtemplating's Introduction

Simple Email Templating

This is a framework for making html emails quickly and more easily. It does this by seperating the header, footer and main content of the email into partials that can be compiled to one cohesive html email. Its does this by utilizing gulp to run builds and nunjucks for templating. This framework is already setup to use some of mailchimps hooks like there view in browser function but they can be easily taken out and replaced with your ESP's hooks or take them out entirely.

How to setup

You can setup this repo to use for your own emails by forking it then cloning it to you machine. Once cloned ,where you want it, run the typical commands you would to install node/npm based work flow.

git clone https://github.com/mburger89/SimpleEmailTemplating.git
cd SimpleEmailTemplating/
npm install

After you run those you should be ready to go. Please Note: you must have node and npm installed for this to work.

How to compile to HTML

To compile your email to html, run.

$ gulp build

To run an http server to view your email before you send, run.

$ gulp serve

note: the file being served is the built html file in app/

To build and run the http server, run.

$ gulp watch

This both builds your email and servers it on a server while watching for any changes, reloading on save of changed files

Future Plans

More functionality will be added as I continue to work on this to make it better.

features I am working on:

  • Being able to auto-build on save.
  • also incorperating juice for inlining styles.

As for right now there is not functionality for that.

simpleemailtemplating's People

Contributors

mburger89 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.