mirror of https://github.com/vale981/Vulcan synced 2025-03-10 12:36:39 -04:00

History

Sacha Greif 2135c4b11f Adding cron job to schedule digests		2014-08-04 19:02:21 +09:00
..
lib	Adding cron job to schedule digests	2014-08-04 19:02:21 +09:00
.gitignore	working on digest package	2014-08-02 11:00:28 +09:00
package.js	Adding cron job to schedule digests	2014-08-04 19:02:21 +09:00
README.md	Adding cron job to schedule digests	2014-08-04 19:02:21 +09:00

README.md

Telescope Digest Package

This package schedules an automatic newsletter digest.

Dependencies

Settings

Newsletter Frequency: how often you want the digest to be sent, in days. Set to 0 to disable digest. Note that changes to this setting require you to restart your app to take effect.
Posts Per Newsletter: how many posts each newsletter should contain.

How It Works

The package works with MailChimp, which means you'll need to fill in an API key and List ID in your Telescope app's settings panel.

Every x days, it builds a digest consisting of the top y items posted in the past x days that haven't yet been sent out in a newsletter.

It then creates a campaign in MailChimp and schedules it to be sent out one hour later (to give you some time to check that everything looks good).

Test Routes

If you want to preview your email templates, you can do so at the following routes:

Digest: http://localhost:3000/email/campaign
Confirmation: http://localhost:3000/email/digest-confirmation

(Replace http://localhost:3000 with your app's URL)