MailSender

A web application that allows you to automate your sales emails! Upload a list of leads and select a template, and automatically send off emails from a connected account!

Prerequisites

• Python 3

  • The project uses Python 3 as its backend language. Download it here.

• pip

  • The project uses pip as its Python package manager. Installation tutorial is here .

• npm

  • The project uses npm as its JavaScript package manager. Installation tutorial is here.

• PostgreSQL

  • The project uses PostgreSQL as its database. Download it here

Getting started

• Cloning this repo: git clone https://github.com/hatchways/team-winter.git

• Setting up virtual environment and dependencies in server:

  • Go to server directory and install pipenv with: pip install pipenv
  • Activate the virtual environment and install dependencies: pipenv install

• Installing dependencies in client:

  • run npm install in client directory

Running app locally

Starting the client:

• Go to client directory and run npm run

Starting the server:

• Go to server directory and run flask run
  • pipenv run flask run if the virtual environment isn't already activated

Setting up the database

Go to config file and set SQLALCHEMY_DATABASE_URI environment variable in the following format:

'postgresql://username:password@localhost/db_name'

Next, create database 'db_name' in your localhost. You can do so in the following commands:

$ psql   # or
$ sudo -u postgres psql -p 5432 -h 127.0.0.1
$ postgresql > create database db_name;

Database migration

Go to server directory

$ python manage.py db migrate   # to prepare the migration steps
$ python manage.py db upgrade   # to apply the latest migration to your database

Technologies

Server-side:

• Python 3

• Flask

• PostgreSQL

• SQLAlchemy

• Redis Queue

• and other commonly used back-end implementations

Client-side:

• ReactJS

• Material-UI

• and other commonly used front-end implementations

Authors

• Yangeng Chen

• Crystal Low

• Benjamin Jenkins