Skip to content

Latest commit

 

History

History
175 lines (119 loc) · 8.18 KB

README.md

File metadata and controls

175 lines (119 loc) · 8.18 KB


Code Climate

There are two important factors for Email marketing. Manage whole process effectively and analysis results easily. If you follow these two factor, your email campaigns will be more successful. Because of flexible time management, less energy and knowledge of right targets. So, guess which tool focused on these two important factors for the good of community? Of course Smart-Emailing did it! You can personalize your emails and use CRM for your emails or inbox. And you can do all of this with a simple dockerized rails app!

🚻 For whom?

🚦 If you need to send automatic emails,
🌈 If you need to create and manage email campaigns with taggings,
🔍 If you need to track your campaigns and analyse your results,
📊 If you need to monitoring your activities,
📑 If you want to use email templates,
🕵️ If you need to add tags or custom data and categorize users,
💯 And if you want to do all of this easily,

Then you're at the right place. Because Smart-Emailing builded for you! 🎉

☑ Features

▶️ CRM:
🔸 Filter users with advanced search such as tags, previous campaign, campaign status or email open status
🔸 Import users from csv (any column name will become custom data)
🔸 Export filtered users to csv and xlsx
🔸 Add tags, custom data to users
🔸 Create a campaign from filtered user result

▶️ Campaign Management:
🔸 Create a campaign from filtered user result
🔸 Campaign's tagging, user-campaign tagging
🔸 Email templates
🔸 Send campaign from any service provider sendgrid, AWS (Send Newsletters 100x cheaper)

▶️ Campaign Results:
🔸 Email stats from sendgrid

▶️ Inbox Management:
🔸 Email inbox parsing and email macthing
🔸 Delete, archive emails from inbox
🔸 Add tags, and campaign-user tags directly from inbox
🔸 Quick template responses from directly from inbox

▶️ Email
🔸 Template emails
🔸 Simple access to any custom fields about the user
🔸 Write any Ruby code
🔸 Support multiple SMTP option
🔸 Support IMAP option

🔱 Installation

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

2- Install Docker Compose

💧 Install docker compose from the 🔗official page.

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- Database Settings

💧 You can use sqlite, postgresql, mysql and sql server.

💧 Create a database.yml and link it in the docker-compose.yml

4- Create data folders

mkdir -p /datadrive/csv-files && mkdir -p /datadrive/data/db && mkdir -p /datadrive/data/redis && mkdir -p /datadrive/data/nginx && mkdir -p /datadrive/working-dir 

5- Create a database.yml

💧 Sqlite

cd /datadrive && wget https://raw.githubusercontent.com/mojilala/smart-emailing/master/config/database.yml

💧 MySQL

cd /datadrive && wget https://raw.githubusercontent.com/mojilala/smart-emailing/master/config/database_mysql.example.yml

💧 PostgreSQL

cd /datadrive && wget https://raw.githubusercontent.com/mojilala/smart-emailing/master/config/database_postgresql.example.yml

💧 Sql SERVER

cd /datadrive && wget https://raw.githubusercontent.com/mojilala/smart-emailing/master/config/database_azure_sql.example.yml

6- Create nginx settings

cd /datadrive/data/nginx && wget https://raw.githubusercontent.com/mojilala/smart-emailing/master/nginx/my_proxy.conf

7- Get docker-compose.yml

💧 Download

cd /datadrive/working-dir && wget https://raw.githubusercontent.com/mojilala/smart-emailing/master/docker-compose.yml

💧 Update environment variables with your settings https://github.com/mojilala/smart-emailing/blob/master/docker-compose.yml#L34

8- Run

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

9- Configure Sendgrid

💧 If you are using sendgrid as email provider, you will be able to get status of sent emails.

💧 Go to: https://app.sendgrid.com/settings/mail_settings -> Event Notification -> <yourhost.com>/campaigns/event_receiver

💝 Contributing

We are so grateful for all volunteers like you for contributions. And we are so exciting to welcome your contributions!🙏 But first, please take a moment to read our 🔗contributing guild to make the contribution process effective for everyone. Our 🔗issue tracker is the preferred channel for bug reports, features requests and submitting pull requests. After that, you can start to fork!

  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

🔎 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.

💪 Team


Sahin Boydas
Creator
LinkedIn

Muhammet
Developer
Github

Sadik
Developer
Github

🎓 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 Smart-Emailing app, 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. 😊