Skip to content

powerticmkt/plugin-grapesjs-builder

 
 

Repository files navigation

GrapesJS Builder with MJML support for Mautic

⚠️ This Plugin is still Beta! It works great already and we're developing it actively! Please use it and report everything inside the "Issues" here in Github. ⚠️

Installation in Mautic 3.x

  1. Navigate to the plugins directory of your Mautic installation via SSH/FTP/SFTP Here you find the SSH Commands to install the plugin (with FTP simply download and drag'n'drop the folders to the right directory)
cd /path/to/mautic/plugins

(path/to/mautic needs to be the correct path where your Mautic is installed. This varies for each installation. It is most likely something like /var/www/html/mautic )

  1. Download the plugin directly to the plugins folder on your server.
sudo wget https://github.com/mautic/plugin-grapesjs-builder/archive/mautic3x.zip
  1. Unzip the content
sudo unzip mautic3x.zip
  1. Move the content of the package to a folder called GrapesJsBuilderBundle
sudo mv plugin-grapesjs-builder-mautic3x  GrapesJsBuilderBundle
  1. Clear Mautic Cache
sudo cd /path/to/mautic
sudo php bin/console cache:clear
  1. Install the plugin in Mautic.

via SSH:

sudo cd /path/to/mautic
sudo php bin/console mautic:plugins:update

or directly in Mautic:

Go to the Plugins tab in Mautic: » Click on the cogwheel (Settings) on the right hand top corner » Go to Plugins » Click on Update Plugins on the right hand top corner

  1. Now activate the Plugin

Head over to the Plugins tab in Mautic: » Click on the cogwheel (Settings) on the right hand top corner » Go to Plugins » Find the Plugin called "GrapesJs" and click on it » Click "yes" in the modal popup » Click the "Save and Close" button

  1. Clear Cache again
sudo cd /path/to/mautic
sudo php bin/console cache:clear

Ready to go. Now the GrapesJs Builder is loaded for Emails and Landing pages.


MJML support

GrapesJS plugin introduce also support for MJML language. Just create template as usual and add to template email.mjml.tpl file with properly formatted MJML syntax.

You can use the Blank MJML template provided by Webmecanik Blank MJML as a starting point.

blank_mjml.zip

Support

Use Github issues for reporting and discuss more about this plugin

Contribution

Create Pull Requests and we will review them soon as possible.

Dependencies

This plugin use following GrapesJS plugin:

If you want to update it, the code can be found in the plugin/GrapesJsBuilderBundle/Assets/js folder.


Switching back to the legacy Builder

In case you are not happy with the plugin at the moment, you can easily switch back to the legacy Builder (original Mautic builder). You can do so very quickly:

  1. Go to Mautic Settings » Click the cogwheel on the right-hand top corner
  2. Open the Plugins Directory » click on "Plugins" inside the menu
  3. Find the GrapesJs Plugin and click on it » Click "No" and then "Save and Close"
  4. Clear the cache

Mautic unloaded the GrapesJs Plugin and uses the legacy builder again.


Support for Mautic 2.x

We are going to delete the branch for the Mautic 2.x Plugin on February 28th 2021. If you feel the need to develop the existing 2.x branch further, please fork it and develop it on your own repo. Here is the link to the 2.x Branch with the work done so far: https://github.com/mautic/plugin-grapesjs-builder/tree/master

About

GrapeJS HTML and MJML integration for Mautic

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 58.6%
  • JavaScript 34.7%
  • CSS 6.7%