Giter VIP home page Giter VIP logo

mailroad's Introduction

MailRoad

builds emails better, hopefully.

Mailroad helps you compose, write, and send emails through the ESP (email service provider) of your choice. It uses react, node, express, and couchdb

The frontend for mailroad has been moved to its own repo.

Development

Dependencies

  • CouchDB >= v2.0
  • redis-server
  • nodeJS >= v8.0
  • an Amazon S3 bucket and API key

Installation

  • Ensure external dependencies are installed and running
  • clone this repo
  • cd to the cloned directory and run npm install
  • copy .env.sample into a new file .env. Add the appropriate API keys for AWS.
  • start couchdb-server
  • npm run seed to create databases and meta info
  • npm run sync-views to upload design docs to appropriate databases.
  • Once you set it all up, start everything.
  • redis-server to start redis
  • npm run develop to start nodemon & express

Don't forget to run the frontend as well!

Layout

Code is divided into /client and /server folders. client contains react router code, jsx, sass, fonts, and some client side libs. server contains the express code (api routes), email templates, server side libs, other logic.

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.