Mailchimp Service

This project marks the glue between the weblingservice and Mailchimp. It uses and wraps Mailchimp's REST API.

It is based on the fabulous Laravel framework to speed up the development. Check out the docs and start contributing 😍.

Contributing ...

... is cool, simple and helps to make the 🌍 a better place 🤩

1. Install docker
2. Start docker
3. Clone this repo git clone https://github.com/grueneschweiz/mailchimpservice.git
4. cd into the folder containing the repo
5. Execute docker compose run app composer install and have a ☕️ while it installs.
6. Execute docker compose run app sh -c 'cp .env.example .env && php artisan key:generate' to generate the app secrets.
7. Execute docker compose up -d to start up the stack. The first time you run this command, it will take a minute or two. Subsequent calls will be much faster.
8. Do the db migrations: docker exec -it wsapp_mailchimp bash and php artisan migrate
9. After a few seconds: Visit localhost:9001. If you get a connection error, wait 30 seconds then try again.

Docker Cheat Sheet

• Install: docker compose run app composer install

• Start up: docker compose up -d

• Shut down: docker compose down

• Execute Laravel CLI commands (enter container): docker exec -it wsapp_mailchimp bash use exit to escape the container.

  • add your first entry php artisan endpoint:add myconfigfile.yml
  • sync an instance php artisan sync:all toMailchimp myconfigfile.yml --limit=10

• Add dependency using composer: docker compose run app composer require DEPENDENCY

Testing

In the main folder run php vendor/phpunit/phpunit/phpunit tests to run the tests locally.

Tooling

Mailhog

All mail you send out of the application will be caught by Mailhog

MySQL

Use the handy phpMyAdmin or access the mysql CLI using docker exec -it wsmysql_mailchimp mysql --user=laravel --password=laravel laravel