iamfiropo/Epic_Mail

Epic mail is a web app that helps people exchange messages/information over the internet.

Epic_Mail

Epic mail is a web app that helps people exchange messages/information over the internet.

Built with LOVE and

• Html
• Css
• Javascript
• Nodejs

Feature

• Guest can create an account
• User can sign in
• User can send an email
• User can view inbox messages
• User can view unread inbox messages
• User can view sent messages
• User can view a particular inbox message
• User can delete a particular inbox message
• User can have a contact list
• User can get all their contacts
• User can create a group
• User can send messages to the group

Gh pages

home

Pivotal Tracker

url

Link to API documentation

• docs

How to clone project

• git clone https://github.com/FrankChinedu/Epic_Mail.git
• cd Epic_Mail
• npm install ( to install dependencies )
• npm start ( to start server)

To test project

 - npm run custom-test  // to run test

Routes (api - end points)

(properly stated in the documentation)

• POST https://epic-mail-ocf.herokuapp.com/api/v1/auth/signup - create new User

• POST https://epic-mail-ocf.herokuapp.com/api/v1/auth/login - Sign in user

• POST https://epic-mail-ocf.herokuapp.com/api/v1/messages - create or send email

• GET https://epic-mail-ocf.herokuapp.com/api/v1/messages/sent - get all user's sent messages

• GET https://epic-mail-ocf.herokuapp.com/api/v1/messages - get all user's inbox messages

• GET https://epic-mail-ocf.herokuapp.com/api/v1/messages/:id - view a particular email from the inbox messages

• GET https://epic-mail-ocf.herokuapp.com/api/v1/messages/unread - get all user's unread messages

• DELETE https://epic-mail-ocf.herokuapp.com/api/v1/messages/:id - delete a message from the inbox

• POST https://epic-mail-ocf.herokuapp.com/api/v1/groups - create group

• GET https://epic-mail-ocf.herokuapp.com/api/v1/groups - get all groups

• UPDATE https://epic-mail-ocf.herokuapp.com/api/v1/groups/1/name - Update group name

• DELETE https://epic-mail-ocf.herokuapp.com/api/v1/groups/1 - delete group

• POST https://epic-mail-ocf.herokuapp.com/api/v1/groups/1/users -add members to a group

• DELETE https://epic-mail-ocf.herokuapp.com/api/v1/groups/1/users/1 - delete a member from the group

• POST https://epic-mail-ocf.herokuapp.com/api/v1/groups/1/messages - send group message

• POST https://epic-mail-ocf.herokuapp.com/api/v1/contacts - create contact

• GET https://epic-mail-ocf.herokuapp.com/api/v1/contacts - get all contacts

• DELETE - https://epic-mail-ocf.herokuapp.com/api/v1/contacts/1 - delete a contact

Project References

---

UI reference

• gmail (I used gmail mock up UI for my UI)
• whatsapp (I used whatsapp interface as inspiration for my responsive version on smaller screens )

---

Swagger

• https://itnext.io/wiring-up-an-api-server-with-express-and-swagger-9bffe0a0d6bd

Server

• thanks to Rexben for letting me use his project as reference https://github.com/Rexben001/Politico
• A big help from this article for working on my db
  • https://www.codementor.io/olawalealadeusi896/building-a-simple-api-with-nodejs-expressjs-postgresql-db-and-jwt-3-mke10c5c5

---

Author

• OBI CHINEDU FRANK

---

Licence

This project is licensed under the MIT License.

MIT © Obi chinedu Frank