Giter Site home page Giter Site logo

mailbot's Introduction

mailbot

A simple application to send email, built using ReactJS as a client side framework and NodeJS as the server.

Setup

installation

client setup

  1. Clone or copy the project from github.
  2. run the following command from the project root directory
npm run client-install

Note: The client react application will run on port 3000. Ensure that no other application is currently using that port.

server setup

  1. run the following command from the project root directory
npm run server-install

Note: The server application will run on port 7000. Ensure that no other application is currently using that port.

You can also run

npm run install 

which will install both the client and server dependencies.

API integration setup

The server project uses Sendgrid and Mailgun APIs for email sending.

Sendgrid

Make sure to update the file variables.env with the Sendgrid API Key. This will be available to you once you sign up with Sendgrid. See https://app.sendgrid.com/settings/api_keys

Mailgun

Make sure to update the file variables.env with the Mailgun Domain and Mailgun API Keys. This will be available to you once you sign up with Mailgun. See https://app.mailgun.com/app/account/security/api_keys for your API key. See https://app.mailgun.com/app/sending/domains to add your custom domain.

running both client and server applications

run the following command from the project root directory

npm start

mailbot's People

Contributors

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