https://github.com/epayet/mjml-starter-kit
MJML starter kit, create responsive emails very quickly using MJML and this productive toolchain
https://github.com/epayet/mjml-starter-kit
email mjml nodejs react starter-kit
Last synced: 4 months ago
JSON representation
MJML starter kit, create responsive emails very quickly using MJML and this productive toolchain
- Host: GitHub
- URL: https://github.com/epayet/mjml-starter-kit
- Owner: epayet
- Created: 2016-02-29T16:20:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-01-23T10:51:22.000Z (over 9 years ago)
- Last Synced: 2025-10-12T11:18:10.638Z (9 months ago)
- Topics: email, mjml, nodejs, react, starter-kit
- Language: JavaScript
- Size: 9.77 KB
- Stars: 35
- Watchers: 2
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MJML starter kit
This is a stater-kit for [MJML](https://mjml.io/).
## Features
* Easy MJML files compilation (`npm run build` to compile every templates)
* Easy dev mode with browser reloading and file watching, even with custom components (`npm start`)
* Contains the examples of the [documentation](https://mjml.io/documentation)
## Usage
### Installation
The only thing you need is NodeJS / NPM, then:
`npm install`
### Build templates to HTML
`npm run build`
This will create the HTML files in the `dist` folder. Reading from templates folder.
### Dev mode
`npm start`
This will start a development server with a watch task and browser reloading.
### Create your own component
`npm run init-component mycomponent`
This will create a js file in the root folder. You need to move it to the `components` folder and add it to the
`components/index.js` file. Then you will be able to use it in your templates as ``.
## Folder structure
```
.
├── components -> Custom components
├── dist -> Build folder with final HTML files
└── templates -> MJML files
```
## Contribute
Pull requests and suggestions are welcome!
## License
The MIT License (MIT)
Copyright (c) 2016 Emmanuel Payet
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.