Book A Meal

This application was developed to enable customers place orders for their favorite meals online, see the menu for a specific day, and also allow the caterers set the menu for the day, add, remove or update a meal and see orders made by customers.

Technologies

• NodeJS - Runtime Environment
• ExpressJs - Web Application Framework
• NPM - Dependency Manager

Supporting Packages

Linter(s)

• ESLint - Linter Tool

Compiler

• Babel - Compiler for Next Generation JavaScript

Test Tools

• Mocha - JavaScript Test Framework for API Tests
• Chai - TDD/BDD Assertion Library for Node
• Istanbul(nyc) - Code Coverage Generator

Features of the app

Users can

• Post A Meal
• Modify A Meal
• Get A Meal
• Get All Meals
• Delete A Meal

Getting Started

Installation

• git clone Book A Meal
• Run yarn install or npm install to install packages
• Run yarn start or npm start to start the server
• Navigate to localhost:5000 in postman or browser to access the application

Testing

Prerequisites

• Postman - API Toolchain

Testing with Postman

• After installing as shown above
• Navigate to localhost:5000 in Postman to access the application

Endpoints to test for

• Post A Meal - http://localhost:5000/api/v1/meals/add-meal
• Get All Meals - http://localhost:5000/api/v1/meals
• Get A Meal - http://localhost:5000/api/v1/meals/:mealId
• Modify A Meal - http://localhost:5000/meals/:mealId
• Delete A Meal - http://localhost:5000/api/v1/meals/:id/delete

Testing with Coverage Data

• After installing as shown

• Run yarn test or npm test

• It will lint code, run test and display coverage data as generated by Istanbul's nyc