franz-josef-kaiser / hull-mailjet

Mailjet Connector for Hull

Hull Mailjet Connector

Overview

A connector fo Hull which allows you to synchronize Hull users to Mailjet, keep their subscriptions synchronized with the segments of Hull users and capture actions such as Email opened, Unsubscribed from Mailjet.

For more documentation, see the Connector Docs.

Usage

After installing dependencies via

npm i

the postinstall script from package.json will be executed to build the JS files. To start the development server which listens to changes in the build folder use

npm run serve-debug

Note The development server uses nodemon and restarts automatically after changes to the JS files have been detected. To prevent continuous restarts, there is no automated conversion from TypeScript to JS, to refelect changes please run

npm run build:js
# or
npm run build

For convenience the script section contains a script to run ngrok and provide a tunnel to your local environment. Make sure to have ngrok installed and then run

npm run ngrok

To run a clustered version of the connector for production, use

npm run start

This will use PM2 with the parameters specified in ecosystem.config.js. For more information about the Ecosystem File, see the PM2 Documentation.

Contributing

This project welcomes contributions and suggestions.

Please read to Contribution Guidelines.

License

MIT License. See LICENSE document for details.