Git Product home page Git Product logo

epic-mail's Introduction

epic-mail

Build Status Coverage Status

an email web app that helps people exchange messages/information over the internet.

Get Started

  • 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

UI View

https://devpinheiro.github.io/epic-mail/UI

API Endpoint

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

epic-mail's People

Contributors

devpinheiro avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.