Epic Mail is a web app that lets people exchange messages/information

1. About the Project

2. Project Status

3. Getting Started

   1. Installation
   2. Testing

4. Project Links

5. REST API

   1. Overview
   2. Sign up
   3. Sign in
   4. Create Email
   5. Get received Email
   6. Get sent Email
   7. Get specific Email

6. Acknowledgment

Epic mail will aid communication between individuals or groups of people

Back to top

# Get the latest snapshot
git clone https://github.com/Tyak99/Epic_Mail myproject

# Change directory
cd myproject

# Install NPM dependencies
npm install

# Create a .env file to root folder
touch .env

# Add postgres database information
DATABASE_URL=your_database_url

# Then simply start your app
npm run dev

# Enter project directory
cd myproject

# Add test postgres database information
TEST_DATABASE_URL=your_database_url

# Start test
npm test

# Enter project directory
cd myproject

# Start test
npm run build

• Gh-Pages Url https://tyak99.github.io/Epic_Mail/Ui/Index.html
• Api documentation https://intense-thicket-60071.herokuapp.com/docs Back to top

The API is generally RESTFUL and returns results in JSON.

• URL

  api/v1/auth/signup

• Method:

  POST

• Data Params

  {
      email,
      password,
      firstName,
      lastName
  }
  

• Success Response

  • Status: 200
  • data:

  {
      token: " "
  }
  

• Error Response

  • Status: 400
  • error: "Email already in use"
  • error: "All fields must be present"

• URL

  api/v1/auth/login

• Method:

  POST

• Data Params

  {
      email: string
      password: string
  }
  

• Success Response

  • Status: 200
  • data:

  {
      token: " "
  }
  

• Error Response

  • Status: 400
  • error: "Invalid email or password"

• URL

  api/v1/messages

• Method:

  POST

• Data Params

  {
      subject: required
      message: required
      emailTo: nullable
      senderId: nullable
      parentMessageId: nullable
  }
  

• Success Response

  • Status: 201
  • data:

  {
      id,
      subject,
      message,
      status,
      createdOn,
      receiverId,
      senderId,
      parentMessageId
  }
  

• Error Response

  • Status: 400
  • error: "Please input all required fields"
  • Status: 404
  • error: "Email not found"

Back to top

• URL

  api/v1/messages

• Method:

  GET

• Body Params

  receiverId: required
  

• Success Response

  • Status: 200
  • data:

  [
      {
          id,
          subject,
          message,
          createdOn,
          status,
          receiverId,
          senderId,
          parentMessageId
      },
  ]
  

• URL

  api/v1/messages/sent

• Method:

  GET

• Data Params

  senderId: required
  

• Success Response

  • Status: 200
  • data:

  [
      {
          id,
          subject,
          message,
          createdOn,
          status,
          receiverId,
          senderId,
          parentMessageId
      },
  ]
  

Back to top

• URL

  api/v1/messages/:id

• Method:

  GET

• Data Params

  messageId: required
  

• Success Response

  • Status: 200
  • data:

  {
          id,
          subject,
          message,
          createdOn,
          status,
          receiverId,
          senderId,
          parentMessageId
    },
  

• Error Response

  • Status: 400
  • error: "Email with id not found"

Babatunde Yakub

• EmbeddedArtistry ( For pull request template and README format )
• Iros ( For api README guideline)

Back to top