Skip to content

Latest commit

 

History

History
87 lines (41 loc) · 2.17 KB

README.md

File metadata and controls

87 lines (41 loc) · 2.17 KB

Recipes CRUD RestFul API

A recipe CRUD API app built on node js , express js and mongodb

The API can be able to add a recipe, edit a recipe, get all recipe or a single recipe and delete a recipe

The Express JS framework handles the API CRUD, mongodb handles the DB storage while Moongoose is used as an Object Document Mapper (similar to an ORM in python)

Requirements

  • NodeJS
  • Mongo DB
  • express JS framework
  • Moongoose

Installation

1. Clone the Github Repositorty'

use npm or yarn using npm

  $ npm install
  $ npm install moongoose
  $ npm install body-parser
  $ npm install express

using yarn

  $ yarn install
  $ yarn add moongoose
  $ yarn add express
  $ yarn add body-parser

2. Run the Application

fire app mongodb in a different terminal

  $ mongod <Path to your db> //eg $ mongod ~ /Documents/mongo/data/db

using npm

    $ npm run

using yarn

    $ yarn run

3. Running the Tests

using npm

     $ npm run test --coverage

using yarn

    $ yarn run test --coverage

Screenshots

screen shot 2018-04-08 at 19 54 07

screen shot 2018-04-08 at 19 54 33

screen shot 2018-04-08 at 19 54 52

screen shot 2018-04-08 at 19 55 11

screen shot 2018-04-08 at 19 55 30

screen shot 2018-04-08 at 19 55 38