chaskiq-newsletters - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #go #android #java #windows #kubernetes #security #mcp #openai #open-source

chaskiq-newsletters

(★ 126)

Newsletter Rails engine

File Explorer

Download Latest Version (.zip)

- - date_time_picker_input.rb
- - application_mailer.rb
- rails
- - kaminari_config.rb
  - simple_form_bootstrap.rb
- routes.rb
- - 20150318021006_create_chaskiq_campaigns.rb
  - 20150318021239_create_chaskiq_templates.rb
  - 20150318021424_create_chaskiq_lists.rb
  - 20150318022506_create_chaskiq_subscribers.rb
  - 20150318023136_create_chaskiq_attachments.rb
  - 20150320031404_create_chaskiq_metrics.rb
  - 20150321205815_create_chaskiq_settings.rb
  - 20150331022602_add_css_to_campaign.rb
  - 20150331025829_add_css_to_chaskiq_template.rb
  - 20150402201729_create_chaskiq_subscriptions.rb
- seeds.rb
- - config.rb
  - csv_importer.rb
  - engine.rb
  - link_renamer.rb
  - version.rb
- - chaskiq_tasks.rake
- chaskiq.rb
- - .env.example
  - config.ru
  - Procfile
  - Rakefile
  - README.rdoc
- - chaskiq_attachments.rb
  - chaskiq_campaigns.rb
  - chaskiq_lists.rb
  - chaskiq_metrics.rb
  - chaskiq_settings.rb
  - chaskiq_subscribers.rb
  - chaskiq_subscriptions.rb
  - chaskiq_templates.rb
- - csv_example.csv
- - config_spec.rb
  - csv_importer_spec.rb
  - link_renamer_spec.rb
- .ruby_version
- rails_helper.rb
- spec_helper.rb
.env.example
.gitignore
.rspec
.travis.yml
chaskiq-admin.png
chaskiq.gemspec
Gemfile
Gemfile.lock
MIT-LICENSE
Rakefile
README.md
TODO.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Chaskiq

### A Rails engine to send newsletters.

![](https://raw.githubusercontent.com/michelson/chaskiq-newsletters/master/chaskiq-admin.png)

<p>The <i><b>Chasquis</b></i> (also <i><b>Chaskiq (Quechua word)</b></i>) 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.</p>

### Motivation.

I really don't like the idea of paying ~50USD/mo to send a simple newsletter, I find that commercial alternatives are really awesome, but those solutions have nothing that the 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 use of variables in templates.
+ Reusable templates.
+ Reusable email lists.
+ Tracks opens and clicks.
+ Tracks bounces and complaints (via AWS SNS).
+ Displays reports on:
  + % of deliveries.
  + clicks, opens, bounces, complaints.
  + Detail list of who opens, clicks, bounces & complains.

### 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 authentication system, just configure the Chaskiq authentication method for controllers.

Assuming you are using Devise, to protect the admin paths you will use the Devise `authenticate_*!` method for controllers as is.

In `config/initializers/chaskiq.rb`:

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

Read about Heroku, VPS installs, Amazon integration and more on the wiki https://github.com/michelson/chaskiq/wiki

# TODO:
- [ ] API support.
- [ ] more insightful reporting
- [ ] 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.