Email Lab

Overview

Email Lab is a project for developing and testing email templates. It uses Grunt, a command-line build tool, to streamline and simplify the creation of email templates.

Features

• Reusable Components: Email templates can be built with reusable components like header and footer.
• Styling Options: Templates can be styled using traditional CSS or Sass, which will be compiled into normal CSS.
• Embedded and Inlined Styles: The build tool converts the traditional styling rules into embedded and inlined styles required for HTML in most email clients.

Setup and Installation with Docker

To set up and install Email Lab using Docker, you will need Docker installed. Follow these steps:

1. Copy settings.sample.json to settings.json and configure the following:
   • From email address
   • Default To email address
   • SMTP Provider settings
2. Run the command docker-compose up to build and run the docker image.
3. Once it finishes, you can access the email templates at http://localhost:9000/ in your browser.

When you are done with development, you can remove the project from Docker by running the command docker-compose down.

Summary

Email Lab is a project that simplifies the development and testing of email templates. It uses Grunt as a build tool and supports reusable components and traditional or Sass styling. The installation process requires Node.js, Grunt.js, and Bundler. Alternatively, you can set up the project using Docker.