EPIC-MAIL

Features

1. Users can sign up.
2. Users can login.
3. Users can create groups.
4. Users can send a message to individuals.
5. Users can view their inbox and read messages.
6. Users can retract sent messages.
7. Users can save an email as draft and send it later or delete it

Tools

Devtools

1. Node and express
2. Babel
3. Eslint
4. Html
5. Css
6. Javascript
7. Postman

Testing frameworks

1. Mocha
2. Chai
3. Chai-Http

Continuous Integration

1. TravisCI

Project Management

• Pivotal Tracker (https://www.pivotaltracker.com/n/projects/2315475)

Github Pages

• Github pages are found on (https://nonsoamadi10.github.io/EPIC-MAIL/)

API DOCUMNETATION

• (https://epicmailapiv1.docs.apiary.io/)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To run this software the following are required for setup:

- A Working Computer (windows, linux or Mac OS X)
- A Command Line Terminal(bash, powershell or shell)
- A Good Text Editor(Vs code, Atom or Sublime Text)
- A Knowledge of basic Computer Operation
- Postman(for testing endpoints)

Installing

A step by step series of examples that tell you how to get a development env running.

- Open the terminal and clone using "git clone"- this repos url

- After clone is successful, Open folder in a text Editor
- Then on terminal "cd into this repo and run *npm install*"
- This installs all dependencies needed for the local env to run
-  Run "npm run build" to build transpile codes to ES5
- Run "npm start" to start server
- Open postman and go to ` GET: localhost:3000/ `
- Response would be  an object that reads {message: "Welcome to the api"}

Running Test

• Run npm Test to see test result and test coverage

Authors

• Amadi Justice Chinonso

Contributors

• W3 Schools
• Traversy Media