https://github.com/inetum-poland/html-email-builder
Inetum Poland HTML Email Builder
https://github.com/inetum-poland/html-email-builder
grapesjs grapesjs-mjml html inetum mjml nuxtjs poland
Last synced: about 2 months ago
JSON representation
Inetum Poland HTML Email Builder
- Host: GitHub
- URL: https://github.com/inetum-poland/html-email-builder
- Owner: Inetum-Poland
- License: mit
- Created: 2024-11-07T13:23:01.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T05:31:47.000Z (8 months ago)
- Last Synced: 2025-05-25T13:48:28.412Z (5 months ago)
- Topics: grapesjs, grapesjs-mjml, html, inetum, mjml, nuxtjs, poland
- Language: TypeScript
- Homepage: https://inetum-poland.github.io/html-email-builder/
- Size: 702 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Concept
With this tool, using a drag-and-drop interface and predefined blocks, you can build an HTML email template that is safe to use in email clients. The result is responsive. Using the preview mode, you can see what the email will look like on different devices. The generated MJML markup gets translated into HTML, which can be used in emails. The project state is saved in a JSON file that contains all the settings and images that are used in the project and can be imported back into the app. Changes will also be automatically saved in the browser to prevent data loss.
## Features
- Drag and drop components:
- Text boxes
- Images
- Buttons
- Columns
- Tables
- Image management:
- Provide source URLs for the images
- Upload images from a drive directly. Uploaded images will be scaled to a maximum resolution and embedded into the document. To keep the size of the document lower, it is recommended to host the images somewhere else and only provide the URLs.
- Edit HTML attributes (e.g. the alt attribute to provide alt text for images or the href attribute for links)
- Edit CSS styles (e.g., text alignment, color changes)
- Preview mode: see what the email will look like on different devices
- Export options:
- Copy HTML to clipboard
- Download the HTML file
- Download the JSON project state file
- Autosave in browser## Integration with email clients
The generated MJML markup gets translated into HTML, which can be used in emails. Email clients require HTML to have specific structure and MJML is an abstraction layer embarking all of these specificities. Compatibility may differ slightly among email clients.
[🔗 MJML component compatibilty with email clients](https://mjml.io/faq#email-clients).
### Outlook
To paste the email into Outlook, use an Outlook Add-In such as [Insert HTML - Outlook Add-In by Inetum](https://github.com/Inetum-Poland/html-email-builder-outlook-addin) and paste the exported HTML code there.
## Available scripts
- `pnpm run build` - build application
- `pnpm run dev` - run dev server
- `pnpm run generate` - build static output
- `pnpm run preview` - start a server to preview the application after the build command
- `pnpm run postinstall` - create a .nuxt directory and generate types
- `pnpm run test` - run tests
- `pnpm run lint` - run linter
- `pnpm run lint:fix` - run linter with autofix
- `pnpm icons:generate` - generate the favicon and the PWA icons based on the `public/logo.svg` image