Mjml Component Boilerplate
A boilerplate to quickly get started when creating your own component
Overview
The "mjml-component-boilerplate" is a boilerplate that allows users to quickly get started when creating their own components. It provides three examples located in the "/components" folder, namely MjBasicComponent, MjImageText, and MjLayout. The examples introduce new features and should be checked in that order. Users can also refer to standard MJML components code, such as the mj-carousel component, for more complex examples.
Features
- Quick Start: Allows users to quickly get started when creating their own components.
- Three Examples: Provides three example components, MjBasicComponent, MjImageText, and MjLayout, to showcase different features.
- Custom Component Installation: Users can easily add their own component by following the provided steps.
- Gulp Integration: The boilerplate comes with a gulpfile.babel.js file that allows users to register their new component.
- Build and Watch: Users can use "npm run build" to build the component or "npm start" to watch and recompile whenever changes are made to the component or index.mjml.
- Node.js Integration: The component can be used in Node.js.
- CLI Integration: The component can be used with the command line interface (CLI).
Summary
The "mjml-component-boilerplate" is a boilerplate that provides users with a quick start when creating their own components. It includes three examples and allows users to easily install and integrate their custom component. The boilerplate supports both Node.js and CLI integration.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Gulp
Gulp.js is an old but popular site building tool that automates various repetitive development tasks in web development, such as compiling Sass, minifying JavaScript, and optimizing images.