Book-A-Meal is an application that allows customers to make food orders and helps the food vendor know what the customers want to eat.

• Technologies
• Features Implemented
• Getting Started
  • Installation
  • Development
  • Testing
• Limitations
• Contributing Guide
• Author

Project is currently being built with the Project Management Tool, Trello. You can find the template HERE

Template is hosted at LINK

API is deployed at https://api-meal-booking.herokuapp.com

Documentation page still in backlog

• HTML
• CSS
• JavaScript
• NodeJS - Runtime Environment
• ExpressJs - Web Application Framework

• ESLint - Linter Tool

• Babel - Compiler for Next Generation JavaScript

• Mocha - JavaScript Test Framework for API Tests (Backend)
• Chai - TDD/BDD Assertion Library for Node

• Users should be able to signin and signup on the app as either a caterer or a customer

• Caterers should be able to create meals
• Caterers should be able to modify meas
• Caterers should be able to delete meals
• Caterers should be able to setup menu for a particular day
• Caterers should be able to modify menu for a particular day
• Caterers should be able to get a particular order
• Caterers should be able to mark a pending order as delivered
• Caterers should be able to get all their orders on the platform
• Caterers should be able to get all their orders for a specific day
• Caterers should be able to get notifications when their meals are ordered

• Customers should be able to make an order
• Customers should be able to modify or cancel an order within 100 seconds of creating it
• Customers should be able to get the menu for the day
• Customers should be able to get a particular order
• Customers should be able to get all their orders on the platform
• Customers should be able to get all their orders for a specific day

• Install NodeJS on your computer
• Clone this repository using git clone https://github.com/vincentiroleh/book-a-meal
• Run npm install to install all dependencies
• Run npm run build to build the project
• Run npm start to start the server
• Navigate to localhost:3000 in browser to access the application

You can run npm run dev in development to use Nodemon

Nodemon watches for file changes and restarts your server.

• Postman - API Toolchain

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

 {
   id:   int,
   name: 'String',
   size: 'String',
   price: 'Int',
 }

• GET: http://localhost:3000/api/v1/meals

• POST: http://localhost:3000/api/v1/meals

• PUT: http://localhost:3000/api/v1/meals/id

• DEL: http://localhost:3000/api/v1/meals/id

 {
   id:   int,
   title: 'String',
   date: 'Data',
   list: '[]',
 }

• POST: http://localhost:3000/api/v1/menu

• GET: http://localhost:3000/api/v1/menu

 {
   id:   int,
   meal: 'String',
   quantity: 'int',
   delivery_address: 'string',
 }

• POST: http://localhost:3000/api/v1/order

• PUT: http://localhost:3000/api/v1/order/id

• GET: http://localhost:3000/api/v1/order

• Application still in progress
• Online Documentation yet to be implement

• Fork the repository
• Make your contributions
• Create a pull request against the develop branch

Vincent Iroleh