README-zh_CN.md

Email Dashboard

🇺🇸English

这个服务可以帮助您管理要发送给用户的通知。这是一个很棒的工具，可以管理您应用中的外发电子邮件。

演示 & 文档

演示： https://dashboard.pigon.ws

文档： https://email-dashboard.readthedocs.io/en/latest

代码概述

• REST API使用超高速语言golang构建。
• 仪表盘使用最快的开发框架Rails构建。
• 仪表盘使用的前端框架为uikit。

特性

• 监控服务发送的电子邮件活动。
• 交互式模板。
• 多个SMTP支持。
• 根据时区计划发送。
• 可选择执行/取消预定活动。
• 跟踪。
• A/B测试。

使用方法

在仪表盘中

• 添加你的SMTP设置。
• 使用handlebars变量创建电子邮件模板。
• 创建通知

发布到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"
   }
}

安装

安装 Docker

Linux

点击official Docker releases为您的平台安装最新版本的Docker Engine，也可以使用以下命令安装：

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

执行这一行以允许Docker不是在root账户下运行

sudo usermod -aG docker ${USER}

注销后再次登录，就有权限运行了。

MacOS

按照安装说明进行操作：https://store.docker.com/editions/community/docker-ce-desktop-mac

安装 Docker Compose

从official page安装下载docker compose，或手动执行：

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

创建数据文件夹

Ubuntu

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

macOS

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

克隆该仓库

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

• 使用你的变量更新环境变量https://github.com/Email-Dashboard/Email-Dashboard/blob/master/.env

• 如果您在macOS上运行，请取消在docker-compose.yml中对应的注释

部署运行

  docker-compose build
  docker-compose run web rake db:migrate
  docker-compose up -d

参与贡献

参考contributing指南。

1. Fork 该仓库
2. 创建一个新的分支 (git checkout -b my-new-feature)
3. 提交你的修改 (git commit -am 'Add some feature')
4. 上传到远程分支 (git push origin my-new-feature)
5. 创建 Pull Request

开发者

Sahin Boydas Product	Muhammet Lead Developer	Sadik Developer	Tommy Yang Developer blog

开源协议

使用本软件须遵守LICENSE中所规定的重要条款和条件。