Code Monkey home page Code Monkey logo

epic-mail's Introduction

EPIC-MAIL

Build Status Coverage Status Maintainability

Features

  1. Users can sign up.
  2. Users can login.
  3. Users can create groups.
  4. Users can send a message to individuals.
  5. Users can view their inbox and read messages.
  6. Users can retract sent messages.
  7. Users can save an email as draft and send it later or delete it

Tools

Devtools

  1. Node and express
  2. Babel
  3. Eslint
  4. Html
  5. Css
  6. Javascript
  7. Postman

Testing frameworks

  1. Mocha
  2. Chai
  3. Chai-Http

Continuous Integration

  1. TravisCI

Project Management

Github Pages

  • Github pages are found on (https://nonsoamadi10.github.io/EPIC-MAIL/)

API DOCUMNETATION

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To run this software the following are required for setup:

- A Working Computer (windows, linux or Mac OS X)
- A Command Line Terminal(bash, powershell or shell)
- A Good Text Editor(Vs code, Atom or Sublime Text)
- A Knowledge of basic Computer Operation
- Postman(for testing endpoints)

Installing

A step by step series of examples that tell you how to get a development env running.

- Open the terminal and clone using "git clone"- this repos url

- After clone is successful, Open folder in a text Editor
- Then on terminal "cd into this repo and run *npm install*"
- This installs all dependencies needed for the local env to run
-  Run "npm run build" to build transpile codes to ES5
- Run "npm start" to start server
- Open postman and go to ` GET: localhost:3000/ `
- Response would be  an object that reads {message: "Welcome to the api"}

Running Test

  • Run npm Test to see test result and test coverage

Authors

  • Amadi Justice Chinonso

Contributors

  • W3 Schools
  • Traversy Media

epic-mail's People

Contributors

nonsoamadi10 avatar

Watchers

 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.