installation.md

Installation

---

$ composer require bitbag/mailchimp-plugin

Add plugin dependencies to your config/bundles.php file:

return [
    ...
    BitBag\SyliusMailChimpPlugin\BitBagSyliusMailChimpPlugin::class => ['all' => true],
];

Import routing on top of your config/routes.yaml file:

# config/routes.yaml

bitbag_sylius_mailchimp_plugin:
    resource: "@BitBagSyliusMailChimpPlugin/Resources/config/routing.yml"

Configure MailChimp credentials

To get info about list id: https://mailchimp.com/developer/marketing/api/lists/get-lists-info/

# .env

...
MAIL_CHIMP_API_KEY=YOUR_KEY

MAIL_CHIMP_LIST_ID=YOUR_LIST_ID

MAIL_CHIMP_WEBHOOK_SECRET=QUERY_PARAMETER_FOR_UNSUBSCRIBED_WEBHHOOK

Read more about MAIL_CHIMP_WEBHOOK_SECRET

You can read more about Mailchimp webhooks here: https://mailchimp.com/developer/marketing/guides/sync-audience-data-webhooks/

Include the newsletter in your template:

{% include '@BitBagSyliusMailChimpPlugin/_subscribe.html.twig' %}

Install the assets

$ bin/console assets:install --symlink

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

<script src="{{ asset('path/to/jquery.js') }}"></script>
<script src="{{ asset('bundles/bitbagsyliusmailchimpplugin/bitbag-mailchimp-plugin-newsletter.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 bitbag-mailchimp-plugin-newsletter.js, create your own *.js plugin and import it in your main Gulpfile.js.