Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 4.47 KB

README.md

File metadata and controls

85 lines (64 loc) · 4.47 KB
Raw

uk.co.vedaconsulting.mosaico

This extension integrates Mosaico a responsive email template editor, with CiviCRM.

How to Install

  1. Have imageMagick installed in your environment. Mainly as php module.
  2. Download extension from https://github.com/veda-consulting/uk.co.vedaconsulting.mosaico/releases/latest.
  3. Unzip / untar the package and place it in your configured extensions directory.
  4. Make sure to keep the directory name as "uk.co.vedaconsulting.mosaico" (for e.g not like - uk.co.vedaconsulting.mosaico-1.0-betaX) to avoid any icon / image loading issues.
  5. When you reload the Manage Extensions page the new “Mosaico” extension should be listed with an Install link.
  6. Click the "Install" link.
  7. Make sure "Extension Resource URL" is configured with Administer » System Settings » Resouce URLs.

Usage

  1. Go to the CiviCRM Mailings menu. Select the new option "Message Template Builder".
  2. Build a template in Mosaico. If you haven't used Mosaico before, a tutorial is available when you select a template when trying it at http://mosaico.io/index.html#about.
  3. When you're done creating your template, click the "Save" link at the top right of the screen.
  4. Clicking Done button after save, will land you on "Mosaico Messages" Tab on civi message templates screen.
  5. To use the template, create a new CiviMail mailing. Your Mosaico template will be available from the "Templates" drop-down menu.
  6. To duplicate mosaico templates, use "copy" link from "Mosaico Messages" tab.

Having issues with this extension?

Please make sure you have followed installation instructions.

To the "Message Template Builder" screen add a runcheck=1 argument in the url to see any errors that might be causing it - url e.g: http://example.org/civicrm/mosaico/index?reset=1&runcheck=1.

Open issues on github with:

  • screenshot of failure with any possible errors in firebug or js console
  • any related logs or backtrace from civicrm
  • tell us what version of CiviCRM and extension, you using.
  • tell us the browser you are using (name and version) and test at least a second browser to tell us if this happen in both or only one (tell us the details about the second browser too).

Development: Requirements

Development: Installation

## Clone the main git repository
git clone https://github.com/veda-consulting/uk.co.vedaconsulting.mosaico
cd uk.co.vedaconsulting.mosaico

## Download dependencies
./bin/setup.sh -D

## Regenerate DAOs
./bin/setup.sh -g

## Build zip archive
./bin/setup.sh -z

Development: Patching Mosaico

This extensions ships with a patched version of Mosaico. The patches are maintained as a fork in https://github.com/civicrm/mosaico using Twigflow (Rebase).

Development: Testing

See TESTING.md

Development: Publication

Whenever a change is merged or pushed to uk.co.vedaconsulting.mosaico, a bot automatically builds a new zip archive and publishes to http://dist.civicrm.org/extension/uk.co.vedaconsulting.mosaico/.

The build/publish process has a few properties:

  • It combines uk.co.vedaconsulting.mosaico, civicrm/mosaic, and any other runtime dependencies into one zip file.
  • The version number is determined by reading info.xml (<version>) and appending the current Unix timestamp.
    • Example: If the version is declared as 1.0.beta1, then it will be published as 1.0.beta1.1478151288.
  • Three files are published:
    • The zip archive
    • The new info.xml file
    • A JSON document describing the build.
  • An alias is provided under the folder latest.

The bot does not publish the new version to civicrm.org. To do this, take the new info.xml file and manually upload it. Since civicrm.org provides a directory of past and current versions, be sure to specify the download-URL for a specific version number (e.g. 1.0.beta1.1478151288) rather than an alias (latest).