📪 An interactive emailing management service with scheduling, templating, tracking and A/B testing.
Branch: master
Clone or download
Pull request Compare This branch is 13 commits ahead, 19 commits behind Email-Dashboard:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
go-api-worker
rails-dashboard
.env
.gitignore
CONTRIBUTING.md
LICENSE
README-tr.md
README-zh_CN.md
README.md
docker-compose-dev.yml
docker-compose.yml

README.md

Email Dashboard

🇨🇳简体中文

This service helps you to manage notifications that you are sending to your users. It's an amazing tool to manage your outgoing emails from your apps.

Demo & Docs

Demo: https://dashboard.pigon.ws

Docs: https://email-dashboard.github.io/guide/

Code Overview

  • The REST API builded with superfast language golang.
  • The Dashboard builded with fastest development framework Rails
  • Front-end framework uikit using in the dashboard.

Features

  • Monitor email activities that your service sent.
  • Interactive templates.
  • Multiple SMTP support.
  • Scheduled delivery with time zone.
  • Perform / Cancel scheduled activities optionally.
  • Tracking.
  • A/B testing.

Usage

In Dashboard

  • Add your SMTP Settings
  • Create email template with handlebars variables.
  • Create notification

Posting to REST API

POST https://api.{{yourhost}}/api/v3/notifications/{{notification-slug}}

Authorization: Token {{AccountToken}}

{
   "variables":{
      "button_name": "Click me!",
      "name": "John"
   },
   "email": {
      "to": ["test@example.com", "second-to@example.com"],
      "cc": ["cc-test@example.com"],
      "reply_to": ["reply-to@example.com"],
      "from": "myapp@example.com"
   },
   "delivery": { # optional
     "time": "21:00",
     "date": "2018-09-22",
     "zone": "Europe/Istanbul"
   }
}

Installation

Install Docker

Ubuntu (Production)

Install the most recent version of the Docker Engine for your platform using the official Docker releases, which can also be installed using:

wget -qO- https://get.docker.com/ | sh

Execute this line to allow docker to execute without being root

sudo usermod -aG docker ${USER}

Logout, then login again. Permissions should be applied.

Install Docker Compose

Install docker compose from the official page, or manually run:

curl -L "https://github.com/docker/compose/releases/download/1.11.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose

Create data folders

 mkdir -p /datadrive/mysql && mkdir -p /datadrive/data/redis

Clone repo

 git clone https://github.com/Email-Dashboard/Email-Dashboard.git

Deployment

  docker-compose build
  docker-compose up -d

Development

Development Installation

Contributing

See contributing guide.

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Authors


Sahin Boydas
Co-Founder @ LeoApp
LinkedIn

Muhammet
Developer @ LeoApp
Github

Sadik
Developer @ LeoApp
Github

Tommy Yang
Developer
Github blog

License

Use of this software is subject to important terms and conditions as set forth in the LICENSE file