an email web app that helps people exchange messages/information over the internet.
-
After cloning the repo, cd into the root folder
-
Install all necessary dependencies by running
npm install -
Launch the node server with
npm run dev -
To run local tests using mocha
npm run test
https://devpinheiro.github.io/epic-mail/UI
all working API endpoints
| HTTP Verb | Endpoint | Description |
|---|---|---|
| POST | /api/v1/auth/signup | create user account |
| POST | /api/v1/auth/login | sign in a user |
| POST | /api/v1/messages | send amil to individuals |
| GET | /api/v1/messages | fetch all received emails for a user |
| GET | /api/v1/messages/sent | fetch all sent emails for a user |
| GET | /api/v1/messages/unread | fetch all unread emails for a user |
| GET | /api/v1/messages/message-id | fetch a specific user's email |
| DELETE | /api/v1/messages/message-id | delete an email in a user's inbox |
| DELETE | /api/v1/messages/retract/message-id | user can retract mails through this endpoint |
| POST | /api/v1/reset | user can reset password |
| GET | /api/v1/confirmReset/:email&:password | user can activate reset password through this endpoint |
| POST | /api/v1/auth/upload | user can upload profile picture |
| GET | /api/v1/groups | user can fetch all groups through this endpoint |
| POST | /api/v1/groups | user can create groups through this endpoint |
| POST | /api/v1/groupsgroup-id/messages | user can send mail to group through this endpoint |
| GET | /api/v1/groups | user can fetch all groups through this endpoint |
| GET | /api/v1/groups/group-id | user can fetch a single group through this endpoint |
| PATCH | /api/v1/groups/group-id | user can edit group name through this endpoint |
| DELETE | /api/v1/groups/group-id/users/user-id | user can delete group member through this endpoint |
| POST | /api/v1/groups/group-id/users | user can add group member through this endpoint |
| GET | /api/v1/api-docs | Swagger API documentation |