kriz83/syliusmailchimpplugin

Mailchimp integration plugin for Sylius

Sylius Mailchimp Plugin

Overview

The plugin allows configuring various MailChimp lists, exporting emails via admin panel & CLI and signing to the newsletter from the shop. It extends BitBag/SyliusMailChimpPlugin and is developed with the contribution of the BitBag team.

Installation

1. Require plugin with composer:

$ composer require setono/sylius-mailchimp-plugin

2. Import configuration:

imports:
    - { resource: "@SetonoSyliusMailchimpPlugin/Resources/config/config.yml" }

3. Import routing:

setono_sylius_mailchimp:
    resource: "@SetonoSyliusMailchimpPlugin/Resources/config/routing.yml"

4. Add plugin class to your bundles.php:

$bundles = [
    new Setono\SyliusMailchimpPlugin\SetonoSyliusMailchimpPlugin(),
];

5. Update your database:

$ php bin/console doctrine:migrations:diff
$ php bin/console doctrine:migrations:migrate

6. Include the newsletter in your template:

{% include '@SetonoSyliusMailChimpPlugin/Shop/_subscribe.html.twig' %}

Add these Javascripts to the layout template that includes your subscription form imported in the previous steps

<script src="{{ asset(path) }}"></script>
<script src="{{ asset('bundles/setonosyliusmailchimpplugin/setono-mailchimp-subscribe.js') }}"></script>
<script>
    $('#footer-newsletter-form').joinNewsletter();
</script>

That's the simplest and fastest way to integrate the jQuery plugin. If you need to customize it, simply take a look at setono-mailchimp-subscribe.js, create your own *.js plugin and import it in your main gulpfile.babel.js.

7. Install assets:

$ php bin/console assets:install --symlink

8. Clear cache:

$ php bin/console cache:clear

Usage

You can now configure Mailchimp lists in your admin UI and later on export them from via admin or the following command:

$ php bin/console setono:mailchimp:export

Testing

$ composer install
$ cd tests/Application
$ yarn install
$ yarn run gulp
$ bin/console assets:install -e test
$ bin/console doctrine:database:create -e test
$ bin/console doctrine:schema:create -e test
$ bin/console server:run 127.0.0.1:8080 -e test
$ bin/behat
$ bin/phpspec run

Contribution

Learn more about our contribution workflow on http://docs.sylius.org/en/latest/contributing/.