Git Product home page Git Product logo

stanley-webmail's Introduction

stanley-webmail (Can be accessed here)

A (private) webmail client that includes utilization of Node.js, Express.js, React.js v4, Redux, Mongoose (MongoDB), Passport, and Socket.io.

Details

  • Source control using Git/GitHub
  • Hosted on Heroku (PaaS)
  • Processes incoming emails
  • Uses a MX catchall in order to parse and process inbound emails.

Sample Account Login(s)

Username Domain Password
public @stanleykerr.co Pass1234
public @tmp.stanleykerr.co Pass1234

Installation Instructions

Note: This project isn't really intended for others to use

But, if you really wanted to set up your own version, follow these steps:

git clone https://github.com/sleepingstanley/stanley-webmail.git
cd stanley-webmail
npm i && npm i --prefix client

This will install all the dependencies required and will use concurrently to launch both the Node.js/Express backend server as well as the React.js frontend server

You're going to need access to a MongoDB database and some way to process incoming emails.

To process incoming emails, you need to set up some kind of inbound-email parser. I suggest trying the free service provided by SendGrid (You'll need to use this project's parse URL)

Create a file named config.local.js in the project's root directory and fill this out:

module.exports = {
  parseURL: 'incoming', // Email that SendGrid/email parser will use to parse emails. It can be accessed by the inbound parser at http://mydomain.com/api/emails/<parseURL>
  mongoURI: 'mongodb://username:password@hostname:port/dbname', // MongoDB URI for database connections
  jwtSecret: 'i like puppies' // Secret key that is used to store session information.
};

If you're running this in production mode, you'll need to set the environment variables instead of using the local file:

  • PARSE_URL
  • MONGODB_URI
  • JWT_SECRET

Next, running npm run dev should auto-launch in your default browser, but if it doesn't, you can open the client manually:


This project was started on July 8th, 2018

stanley-webmail's People

Contributors

stanleykerr avatar

Watchers

 avatar

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.