Skip to content

caulfield/chaskiq

 
 

Repository files navigation

Chaskiq

A Rails engine to send newsletters.

The Chasquis (also Chaskiq (Quechua word)) were agile and highly trained runners that delivered messages royal delicacies such as fish and other objects throughout the Inca Empire, principally in the service of the Sapa Inca.

Motivation.

I really don't like the idea to pay ~50USD/mo to send a simple newsletter, I find that commertial alternatives are really awesome, but those solutions have nothing that OS community can't achieve.

How it works.

Chaskiq works with Amazon SES to send mails and Amazon SNS service to get the bounces & complaints. The SNS integration is optional but recommended in order to get those features.

Features:

  • Email template editor out of the box.
  • Mustache tags enables to use variables in templates.
  • Reusable templates.
  • Reusable email lists.
  • Tracks opens and clics.
  • Tracks Bounces and Complaints (via AWS SNS).
  • Displays reports on:
    • % of deliveries.
    • clicks , opens , bounces, complaints.
    • Detail list off who opens, clicks, bounces & complaints.

How to install:

Use chaskiq as a gem in a rails project.

  • gem 'chaskiq' in your gemfile and execute bundle install

  • rails generate chaskiq:install (will add an initializer , route & migrations)

  • rake db:migrate

  • config/initializers/active_job.rb ActiveJob::Base.queue_adapter = :sidekiq

Secure system:

you can use any user system just configue Chaskiq authentication method for controllers.

assuming you are using device, to protect the admin paths you will use the device's auth method for controllers as is.

config/initializers/chaskiq.rb

Chaskiq::Config.setup do |config|
  config.authentication_method = :authenticate_user!
end

read more about heroku and vps installs, Amazon integration and more in our wiki page https://github.com/michelson/chaskiq/wiki

TODO:

  • api support.
  • more insighfull reportery.
  • scheduled deliveries via (sidetiq or whenever).
  • send to many lists in one campaign and send to list segments (like mailchimp).

Miguel Michelson Martinez. released under MIT.

About

Newsletter Rails engine

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 42.9%
  • HTML 29.5%
  • CSS 13.8%
  • CoffeeScript 12.0%
  • JavaScript 1.8%