Skip to content

Latest commit

 

History

History
40 lines (37 loc) · 2.05 KB

README.md

File metadata and controls

40 lines (37 loc) · 2.05 KB
Raw

MealBookingApplication

Book A meal is an Ecommerce web app, specially built to help user(customer) find and order available resturants and available meal for the day. Vendors can also set up menu for the day and recieve orders

Build Status Coverage Status Maintainability

Getting Started

SETUP

Clone the Repo.

git clone https://github.com/tomesyy/Andela-meal-application.git

Prerequisites

The following tools will be needed to run this application successfully:

  • Node v10.15.0 or above
  • Npm v6.4 or above

Endpoints

  • GET api/v1/meals/ Caterers can get all meals options they uploaded
  • POST api/v1/meals/ Catereres can add meal options linked to their account
  • PUT api/vi/meals/:mealId Caterers can update their meal options
  • DELETE api/v1/meals/:mealId Caterers can delete their meal options
  • GET api/v1/menu/ Caterers and Users can Get the menu for the day
  • POST api/v1/menu/ Caterers can Set a menu for the day
  • GET api/v1/orders Get All Orders
  • POST api/v1/orders Users can make orders
  • PUT api/v1/orders/:orderId Users can modify their orders

INSTALLATION INSTRUCTION

On your Local Machine

  • Pull the develop branch off this repository
  • Run npm install to install all dependencies
  • Run npm start to start the app
  • Access endpoints on localhost:3000

Running the tests

Run npm test in the terminal for the cloned folder.

Built With

Acknnowledgments

  • Andela
  • forloop Africa

Authors

  • Adesanya Adetomiwa