Giter VIP home page Giter VIP logo

node-mongo's Introduction

ReST API starter using express, mongodb and apidoc

Technology Stack

  • Node 6.9.2
  • Express 4.14.0
  • MongoDB 3+

Packages and tools used

  • bcryptjs
  • jsonwebtoken
  • helmet
  • lodash
  • winston
  • mocha
  • supertest
  • eslint
  • apidoc

Installation

  • Clone the repo git clone https://github.com/exp-anoop/node.git seed.
  • Install dependencies cd seed && rm -rf .git && yarn.
  • Run yarn run serve for starting the application (will check the code quality before starting the application).
  • Run yarn run build for run the tests and genarate apidoc.

Core modifications

Added two new functions to response object

  1. res.return() - This function is a replacement for res.send(), using this function we include additional information to the response such as message, status and data.
  • Example res.return({name: "Anoop"}) // Output {"message":"OK","status":200, data: {name: "Anoop"}}
  1. res.message() - To send custom message along with the response, by default it will take standard http message.
  • Example 1: res.status(500).message("Some thing went wrong with the server").return() // Response {"message":"Some thing went wrong with the server","status":500}
  • Example 2: res.status(500).return() // Response {"message":"Internal Server Error","status":500}

Demo Link

https://blooming-bayou-26551.herokuapp.com

"Detailed documentation in progress, also share your valuable comments and features to be added to the seed"

node-mongo's People

Contributors

exp-anoop avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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.