Skip to content

An email messaging project for Andela's Bootcamp cycle 42.

License

Notifications You must be signed in to change notification settings

EmmanuelSage/EpicMail

Repository files navigation

Epic Mail

Epic Mail is a web application that helps people exchange messages/information over the internet.

Coverage Status Build Status GitHub

Built with

  • Node Js
  • Express
  • Babel
  • Eslint
  • Mocha and Chai

Requirements to run

To install this project you would need to have installed:

  • Node js
  • Git (vcs)

To run :

$ git clone https://github.com/EmmanuelSage/EpicMail.git
$ cd EpicMail
$ npm install
$ npm start

To test :

$ npm test

Pivotal Tracker Stories

https://www.pivotaltracker.com/n/projects/2315478

Template for the ui is hosted at

https://emmanuelsage.github.io/EpicMail/UI

Api Documentation link

https://esepicmail.herokuapp.com/api-docs

Api Endpoints

Endpoints Description
POST /auth/signup Signs up a new user
POST /auth/login login a signed up user
POST /messages Sends/creates a new message
GET /messages Fetch all received messages
GET /messages/unread Fetch all unread messages
GET /messages/sent Fetch all sent messages
GET /messages/{id} Fetch a specific message
DELETE /messages/{id} Delete a specific message
POST /groups Create a Group
GET /groups Get all created groups
PATCH /groups/:id/name Edit group name
DELETE /groups/:id Delete a specific group
POST /groups/:groupid/users Add a user to a group
DELETE /groups/:groupid/users/:userid Delete a user from a group
POST /groups/:id/messages Post a message to a group
POST /messages/drafts Create a draft message
GET /messages/drafts Get a draft message
DELETE /messages/drafts/:id Delete a draft message
DELETE /groups/:id Get a specific group
POST /auth/resetemail/ Send email for reset password
POST /auth/resetpassword/ Reset a user's password
DELETE /messages/retract/:id Retracts a message
PATCH /auth/upload/ Uploads a profile picture
GET /auth/user/ Get a user's detail

Author

Emmanuel Oluyale

License

This is licensed for your use, modification and distribution under the MIT license.

About

An email messaging project for Andela's Bootcamp cycle 42.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published