GithubHelp home page GithubHelp logo

email-dashboard / email-marketing Goto Github PK

View Code? Open in Web Editor NEW
176.0 20.0 41.0 6.96 MB

๐Ÿ“ช Super customizable Emailing - Personalized Email & Mass emailing & Email CRM & CRM in your Inbox

License: Other

Ruby 64.89% JavaScript 2.42% CSS 1.63% HTML 30.42% Dockerfile 0.64%
email-marketing campaign filter-users growth-hacking marketing marketing-emails sendgrid ruby-on-rails email emailing

email-marketing's Introduction

Report bug | Request feature | Help issues | ๐Ÿ‡จ๐Ÿ‡ณ[็ฎ€ไฝ“ไธญๆ–‡]


Go Report Card

Email-Dashboard is an easy way to manage your outgoing emails from your apps. From creating and sending your emails to monitoring and managing their stats, you can do really useful things with Email-Dashboard without worried about time zone disaverage. You can ๐Ÿ”—explore Email-Dashboard docs.

๐Ÿ’ข Table of content

๐Ÿšป For whom?

๐ŸŒ If you need to send automatic emails without worried about time zone,
๐Ÿ” If you need to track your emails and analyse your results to follow better strategies,
๐Ÿ“Š If you need to monitoring your activities,
๐Ÿ“‘ If you want to use email templates,
๐Ÿ•ต๏ธ If you need to A/B testing,
๐Ÿ’ฏ And if you want to do all of this easily,

Then you're at the right place. Email Dashboard builded for you! ๐ŸŽ‰

๐Ÿ‘€ 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.
  • Mobile UI
  • Email tracking.
  • A/B testing.

๐Ÿ”ฑ Deployment

Debian

1- Install Docker

โ–ถ๏ธ 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.

2- 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

3- Create data folders

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

4- Clone repo

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

โ–ถ๏ธ Update environment variables with your variables https://github.com/Email-Dashboard/Email-Dashboard/blob/master/.env

  docker-compose build
  docker-compose up -d

๐Ÿ’ป Development

macOS

Install and start Docker, check ๐Ÿ”— docker-ce-desktop-mac.

โ–ถ๏ธ Create Datafolders

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

โ–ถ๏ธ Clone the repo

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

โ–ถ๏ธ Update mac username in docker-compose-dev.yml in line 7 and line 27

/Users/MacUserName/datadrive/ed/mysql:/var/lib/mysql # update MacUserName with yours

โ–ถ๏ธ Start

docker-compose -f docker-compose-dev.yml build
docker-compose -f docker-compose-dev.yml up

โ–ถ๏ธ Dashboard url: http://localhost:3000
โ–ถ๏ธ Make API requests to http://localhost:8080

Debian

Install and start Docker:

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.

โ–ถ๏ธ Create Datafolders

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

โ–ถ๏ธ Clone the repo

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

โ–ถ๏ธ Update line 7 and line 27 in docker-compose-dev.yml to:

-'/datadrive/data/mysql:/var/lib/mysql'
...
- '/datadrive/data/redis:/data'

โ–ถ๏ธ Start

docker-compose -f docker-compose-dev.yml build
docker-compose -f docker-compose-dev.yml up

โ–ถ๏ธ Dashboard url: http://localhost:3000
โ–ถ๏ธ Make API requests to http://localhost:8080

๐Ÿ† Usage

1- In Dashboard

Using dashboard is really easy, like playing PUBG! You can do it any time without any effort. Because our first aim is make some time for our community with our dashboard. So, UI and dashboard is friendly as much as and we will make it better.

๐Ÿ”ธ Add your SMTP Settings
๐Ÿ”ธ Create email template with ๐Ÿ”—handlebars variables.
๐Ÿ”ธ Create notification. See, easy peasy!

2- 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": ["[email protected]", "[email protected]"],
      "cc": ["[email protected]"],
      "reply_to": ["[email protected]"],
      "from": "[email protected]"
   },
   "delivery": { # optional
     "time": "21:00",
     "date": "2018-09-22",
     "zone": "Europe/Istanbul"
   }
}

For more specified usage you can follow ๐Ÿ”—step by step instructions in docs.

๐Ÿ’ Contributing

Please read our ๐Ÿ”—contribution guidelines. We are grateful for all contributions! ๐Ÿ™ With following our ๐Ÿ”—rules of the discussions, you can contribute many of way. Our ๐Ÿ”—issue tracker is the preferred channel for bug reports, features requests and submitting pull requests. We utilized several ๐Ÿ”—labels to help organize and identify issues. You can start with there! Also if you want to add some new feature:

  1. Clone or fork the project (git clone https://github.com/Email-Dashboard/Email-Dashboard)
  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

๐Ÿ”Ž But before opening a feature request, please take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. So, you can provide as much detail and context as possible.

๐Ÿ“ Authors


Sahin Boydas
Product
LinkedIn

Muhammet
Lead Developer
Github

Sadik
Developer
Github

Tommy Yang
Developer
Github blog

๐ŸŽ“ License

This program is a free and open source software. You can redistribute it and/or modify it under the terms of the license provided in the ๐Ÿ”—LICENSE file. Use of this software is subject to important terms and conditions as set forth in the ๐Ÿ”—LICENSE file.

๐Ÿ” Acknowledgement

If you liked our dashboard, please give us a "Star" โญ. Your support is what keep us moving forward and delivering happiness to you! Thank's a million, you're our Clark Kent/Kara Danvers! In case of any questions or concerns, feel free to contact us anytime. Btw you can see our guilds from our ๐Ÿ”—credit content ๐Ÿ˜Š

email-marketing's People

Contributors

adamdilek avatar mesutgulecen avatar sadikay avatar sahin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

email-marketing's Issues

User creation API

Add authentication_token to Account . Set this value using Devise.friendly_token

Also, account able to renew authentication_token

  • POST /users
  • PUT /users/:email

A very useful functional suggestion

hello,
Use a random number as the time interval for sending.
For example: set from 1 second to 60 seconds. When sending, automatically select a number within this range as the sending interval.
We've done a lot of sending tests, which will have a better effect and won't be marked as spam.

can not create a user

When I try to create account it fails, and rollback

Loading production environment (Rails 5.0.1)
irb(main):001:0> Account.create(email: "[email protected]", password: "yourpassword", password_confirmation: "yourpasword")
(0.3ms) begin transaction
Account Exists (0.6ms) SELECT 1 AS one FROM "accounts" WHERE "accounts"."email" = ? LIMIT ? [["email", "[email protected]"], ["LIMIT", 1]]
(0.3ms) rollback transaction
=> #<Account id: nil, email: "[email protected]", created_at: nil, updated_at: nil, authentication_token: nil>
irb(main):002:0>

I tried different emails, but still failng

default username(email) and password

after i start up all the service with docker-compose command
then ,what's the default username(email) and password for login.
i couldn't found it.
i also change follow environment. but still can not login
SIDEKIQ_USERNAME: sidekiqUsername
SIDEKIQ_PASSWORD: sidekiqPass

Getting error for sidekiq when running sudo docker-compose run web rake db:migrate

johnf@unit3:/Email-Marketing-1.2.2$ sudo docker-compose build
redis uses an image, skipping
nginx-proxy uses an image, skipping
sidekiq uses an image, skipping
web uses an image, skipping
whoami uses an image, skipping
johnf@unit3:
/Email-Marketing-1.2.2$ sudo docker-compose run web rake db:migrate
Starting emailmarketing122_sidekiq_1

ERROR: for sidekiq Cannot start service sidekiq: failed to create shim: OCI runtime create failed: container_linux.go:380: starting container process caused: process_linux.go:545: container init caused: rootfs_linux.go:75: mounting "/datadrive/database.yml" to rootfs at "/smart-email-marketing/config/database.yml" caused: mount through procfd: not a directory: unknown: Are you trying to mount a directory onto a file (or vice-versa)? Check if the specified host path exists and is the expected type
ERROR: Encountered errors while bringing up the project.

help setting it up

hi there,
would you be able to help me over Teamviewer to set this up please ?
i have installed it and made changes but i cant get into the login page , only seeing the landing page

Add notes

Simple scaffold

Note

title
content
account_id

please use a simple wysiwyg editor for content

demande informations

hello creator,

i found your amazing application and i'm interested in using it but i'd like to ask few questions first.

  • about : smart-emailing ... does this application provide smtp server or should i have one like postal from atech. and will it manage bounce, invalid emails, and clean the list from all incorrect data ?
  • should i have this dashboard (https://github.com/Email-Dashboard/Email-Dashboard) connected to the first application ? or it can work by it self ? thank again for this application

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.