chore(git): add current files

Author: s-be

.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+node_modules
+.sass-cache
+.secret
+preview/css
+src/css/*.css
+*.css.map
+*.code-workspace
+secrets.json
+dist/*
+!dist/.gitkeep

.nvmrc

@@ -0,0 +1 @@
+lts/erbium

Gruntfile.js

@@ -0,0 +1,23 @@
+module.exports = function(grunt) {
+
+  require('load-grunt-config')(grunt, {
+
+    // Pass data to tasks
+    data: {
+
+      // Re-usable filesystem path variables
+      paths: {
+        src:        'src',
+        src_img:    'src/img',
+        dist:       'dist',
+        dist_img:   'dist/img',
+        preview:    'preview'
+      },
+
+      // secrets.json is ignored in git because it contains sensitive data
+      // See the README for configuration settings
+      secrets: grunt.file.readJSON('secrets.json')
+
+    }
+  });
+};

dist/.gitkeep

@@ -0,0 +1,38 @@
+# Where we tell Grunt what to do when we type "grunt" into the terminal
+# $ grunt
+default:
+  - 'clean'
+  - 'sass:dist'
+  - 'assemble'
+  - 'juice'
+  - 'imagemin'
+  - 'replace:src_images'
+
+# Use grunt send if you want to actually send the email to your inbox
+# $ grunt send --template=transaction.html
+send:
+  - 'mailgun'
+
+# Upload images to your CDN on Rackspace Cloud Files
+# $ grunt rsupload
+rsupload:
+  - 'default'
+  - 'cloudfiles'
+  - 'cdn:cloudfiles'
+
+# Upload image files to Amazon S3
+# $ grunt s3upload
+s3upload:
+  - 'default'
+  - 'aws_s3:prod'
+  - 'cdn:aws_s3'
+
+# Launch the express server and start watching
+# $ grunt serve
+serve:
+  - 'default'
+  - 'sass:preview'
+  - 'autoprefixer:preview'
+  - 'express'
+  - 'open'
+  - 'watch'

grunt/aliases.yaml

@@ -0,0 +1,14 @@
+// Assembles your email content with HTML layout
+module.exports = {
+  options: {
+    layoutdir: '<%= paths.src %>/layouts',
+    partials: ['<%= paths.src %>/partials/**/*.hbs'],
+    helpers: ['<%= paths.src %>/helpers/**/*.js'],
+    data: ['<%= paths.src %>/data/*.{json,yml}'],
+    flatten: true
+  },
+  pages: {
+    src: ['<%= paths.src %>/emails/*.hbs'],
+    dest: '<%= paths.dist %>/'
+  }
+};

grunt/assemble.js

@@ -0,0 +1,9 @@
+// Browser-based preview task
+module.exports = {
+  preview: {
+    options: {
+      browsers: ['last 6 versions', 'ie 9']
+    },
+    src: 'preview/css/preview.css'
+  }
+}

grunt/autoprefixer.js

@@ -0,0 +1,24 @@
+// Use Amazon S3 for images
+// grunt s3upload
+module.exports = {
+  options: {
+    accessKeyId: '<%= secrets.s3.key %>', // See README for secrets.json
+    secretAccessKey: '<%= secrets.s3.secret %>', // See README for secrets.json
+    region: '<%= secrets.s3.region %>', // Enter region or leave blank for US Standard region
+    uploadConcurrency: 5, // 5 simultaneous uploads
+    downloadConcurrency: 5 // 5 simultaneous downloads
+  },
+  
+  prod: {
+    options: {
+      bucket: '<%= secrets.s3.bucketname %>', // Define your S3 bucket name in secrets.json
+      differential: true, // Only uploads the files that have changed
+      params: {
+        CacheControl: '2000'
+      }
+    },
+    files: [
+      {expand: true, cwd: '<%= paths.dist_img %>', src: ['**'], dest: '<%= secrets.s3.bucketdir %>/<%= paths.dist_img %>'}
+    ]
+  }
+};

grunt/aws_s3.js

@@ -0,0 +1,24 @@
+// CDN will replace local paths with your CDN path
+module.exports = {
+  cloudfiles: {
+    options: {
+      cdn: '<%= secrets.cloudfiles.uri %>', // See README for secrets.json or replace this with your cdn uri
+      flatten: true,
+      supportedTypes: 'html'
+    },
+    cwd: './<%= paths.dist %>',
+    dest: './<%= paths.dist %>',
+    src: ['*.html']
+  },
+  
+  aws_s3: {
+    options: {
+      cdn: '<%= secrets.s3.bucketuri %>/<%= secrets.s3.bucketname %>/<%= secrets.s3.bucketdir %>', // See README for secrets.json or replace this with your Amazon S3 bucket uri
+      flatten: true,
+      supportedTypes: 'html'
+    },
+    cwd: './<%= paths.dist %>',
+    dest: './<%= paths.dist %>',
+    src: ['*.html']
+  }
+};

grunt/cdn.js

@@ -0,0 +1,4 @@
+// Clean your /dist folder
+module.exports = {
+  clean: ['!<%= paths.dist %>/.gitkeep', '<%= paths.dist %>/**/*']
+};

grunt/clean.js

@@ -0,0 +1,15 @@
+// Use Rackspace Cloud Files if you're using images in your email
+// grunt cdnify
+module.exports = {
+  prod: {
+    'user': '<%= secrets.cloudfiles.user %>', // See README for secrets.json or replace this with your user
+    'key': '<%= secrets.cloudfiles.key %>', // See README for secrets.json or replace this with your own key
+    'region': '<%= secrets.cloudfiles.region %>', // See README for secrets.json or replace this with your region
+    'upload': [{
+      'container': '<%= secrets.cloudfiles.container %>', // See README for secrets.json or replace this with your container name
+      'src': '<%= paths.dist_img %>/*',
+      'dest': '/',
+      'stripcomponents': 0
+    }]
+  }
+};

grunt/cloudfiles.js

@@ -0,0 +1,12 @@
+// Browser-based preview task
+module.exports = {
+  server: {
+    options: {
+      port: 4000,
+      hostname: '127.0.0.1',
+      bases: ['<%= paths.dist %>', '<%= paths.preview %>', '<%= paths.src %>'],
+      server: './server.js',
+      livereload: true
+    }
+  }
+}

grunt/express.js

@@ -0,0 +1,16 @@
+// Compress images
+module.exports = {
+  dynamic: {
+    options: {
+      optimizationLevel: 3,
+      svgoPlugins: [{ removeViewBox: false }]
+    },
+    
+    files: [{
+      expand: true,
+      cwd: '<%= paths.src_img %>',
+      src: ['**/*.{png,jpg,gif}'],
+      dest: '<%= paths.dist_img %>'
+    }]
+  }
+};

grunt/imagemin.js

@@ -0,0 +1,20 @@
+// Inlines your CSS
+module.exports = {
+  your_target: {
+    options: {
+      preserveMediaQueries: true,
+      applyAttributesTableElements: true,
+      applyWidthAttributes: true,
+      preserveImportant: true,
+      preserveFontFaces: true,
+      webResources: {
+        images: false
+      }
+    },
+    files: [{
+      expand: true,
+      src: ['<%= paths.dist %>/*.html'],
+      dest: ''
+    }]
+  }
+};

grunt/juice.js

@@ -0,0 +1,18 @@
+// Send your email template to Litmus for testing
+// grunt litmus --template=transaction.html
+module.exports = function(grunt) {
+  return {
+    test: {
+      src: ['<%= paths.dist %>/'+grunt.option('template')],
+      options: {
+        username: '<%= secrets.litmus.username %>', // See README for secrets.json or replace this with your username
+        password: '<%= secrets.litmus.password %>', // See README for secrets.json or replace this with your password
+        url: 'https://<%= secrets.litmus.company %>.litmus.com', // See README for secrets.json or replace this with your company url
+        clients: ['android4', 'aolonline', 'androidgmailapp', 'aolonline', 'ffaolonline',
+        'chromeaolonline', 'appmail6', 'iphone6', 'ipadmini', 'ipad', 'chromegmailnew',
+        'iphone6plus', 'notes85', 'ol2002', 'ol2003', 'ol2007', 'ol2010', 'ol2011',
+        'ol2013', 'outlookcom', 'chromeoutlookcom', 'chromeyahoo', 'windowsphone8'] // https://#{company}.litmus.com/emails/clients.xml
+      }
+    }
+  }
+};

grunt/litmus.js

@@ -0,0 +1,15 @@
+// Use Mailgun option if you want to email the design to your inbox or to something like Litmus
+module.exports = function(grunt) {
+  return {
+    mailer: {
+      options: {
+        key: '<%= secrets.mailgun.api_key %>', // See README for secrets.json or replace this with your own key
+        domain: '<%= secrets.mailgun.domain %>', // See README for secrets.json or replace this with your own email domain
+        sender: '<%= secrets.mailgun.sender %>', // See README for secrets.json or replace this with your preferred sender
+        recipient: '<%= secrets.mailgun.recipient %>', // See README for secrets.json or replace this with your preferred recipient
+        subject: 'This is a test email'
+      },
+      src: ['<%= paths.dist %>/'+grunt.option('template')]
+    }
+  }
+};

grunt/mailgun.js

@@ -0,0 +1,6 @@
+// Browser-based preview task
+module.exports = {
+  preview: {
+    path: 'http://localhost:4000'
+  }
+}

grunt/open.js

@@ -0,0 +1,25 @@
+// Replace compiled template images sources from ../src/html to ../dist/html
+module.exports = {
+  src_images: {
+    options: {
+      usePrefix: false,
+      patterns: [
+        {
+          match: /(<img[^>]+[\"'])(\.\.\/src\/img\/)/gi,  // Matches <img * src="../src/img or <img * src='../src/img'
+          replacement: '$1../<%= paths.dist_img %>/'
+        },
+        {
+          match: /(url\(*[^)])(\.\.\/src\/img\/)/gi,  // Matches url('../src/img') or url(../src/img) and even url("../src/img")
+          replacement: '$1../<%= paths.dist_img %>/'
+        }
+      ]
+    },
+
+    files: [{
+      expand: true,
+      flatten: true,
+      src: ['<%= paths.dist %>/*.html'],
+      dest: '<%= paths.dist %>'
+    }]
+  }
+};

grunt/replace.js

@@ -0,0 +1,33 @@
+// Takes your SCSS files and compiles them to CSS
+const sass = require('node-sass');
+
+module.exports = {
+  dist: {
+    options: {
+      style: 'expanded',
+      implementation: sass
+    },
+    files: [
+      {
+        expand: true, 
+        flatten: true, // do not create subfolders
+        cwd: '<%= paths.src %>/css/scss/',
+        src: ['*/**/*.scss', '!*/**/_*.scss'],
+        dest: '<%= paths.src %>/css/', 
+        ext: '.css',
+      }
+    ]
+  },
+
+  // This task compiles Sass for the browser-baed preview UI.
+  // You should not need to edit it.
+  preview: {
+    options: {
+      style: 'compressed',
+      implementation: sass
+    },
+    files: {
+      '<%= paths.preview %>/css/preview.css': '<%= paths.preview %>/scss/preview.scss'
+    }
+  }
+};

grunt/sass.js

@@ -0,0 +1,21 @@
+// Watches for changes to CSS or email templates then runs grunt tasks
+module.exports = {
+  emails: {
+    files: ['<%= paths.src %>/css/scss/*/**','<%= paths.src %>/emails/*','<%= paths.src %>/layouts/*','<%= paths.src %>/partials/**/*','<%= paths.src %>/data/*'],
+    tasks: ['default']
+  },
+  preview_dist: {
+    files: ['./dist/*'],
+    tasks: [],
+    options: {
+      livereload: true
+    }
+  },
+  preview: {
+    files: ['<%= paths.preview %>/scss/*'],
+    tasks: ['sass:preview','autoprefixer:preview'],
+    options: {
+      livereload: true
+    }
+  }
+};

grunt/watch.js

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [2014] [Lee Munroe]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.