kagaramag/epicmail

EPIC Mail is web app that help people to send and receice messages.

EPIC Mail is web app that help people to send and receice emails. It uses Twilio to notify the arrival of email.

App Links

Server

UI

User Interface

Server

Prerequisites

You need to install the following to be able to run the project on your local machine.

To check if you have Node.js installed, run this in CLI:

node -v

To confirm that you have npm installed you can run this CLI

npm -v

Clone the repository locally

https://github.com/djallas/epicmail.git

Run the tests and check coverage

npm test

How to Run App

npm start

Table of API Endpoints

##API VERSION 2

Methods	Endpoints	Actions
/GET	/	Welcome message
/GET	/api/v2/docs	Swagger Documentation
/POST	/api/v2/auth/signup	Sign up a new user
/POST	/api/v2/auth/login	Get list of contactsLogin a user
/GET	/api/v2/users	Get list of users
/POST	/api/v2/messages	Send an amail
/GET	/api/v2/messages	Fetch all received emails
/GET	/api/v2/messages/unread	Fetch all unread emails
/GET	/api/v2/messages/sent	Fetch all sent emails
/DELETE	/api/v2/messages/{messageId}	Delete a specific email
/GET	/api/v2/messages/{messageId}	Get a specific email
/POST	/api/v2/groups	Create a group
/GET	/api/v2/groups	Get a list of group
/GET	/api/v2/contacts	Get list of contacts

Author

Gilles Kagarama

Twitter: @kagaramag

Scotch.io: @kagarama