book-a-meal

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

View App: book-a-meal

Features

Users

• Signup and Login
• Make an Order
• Modify an Order
• View Menu for the Day
• View their Order History

Caterer

• Create meals
• Modiy meals
• Delete meals
• Setup menu for Particular Day
• Get All Orders for a Specific Day
• Get All Orders for a Specific User
• View Order Summary for Specific Day

Installation

Clone repo to your local machine:

git clone https://github.com/Dikaeinstein/book-a-meal.git

Install dependencies and run locally
Note>> Install yarn if not already installed on local machine: 'npm i -g yarn'

Then run:

yarn install

Create .env like the .env.sample file, just replace with your own enviroment variables.

Now start the server:

yarn start
yarn start-dev     /* Keep watching files for changes */

Testing

To run tests:

yarn test

API

API is deployed at here on heroku.

API Routes

HTTP VERB	ENDPOINT	FUNCTIONALITY
POST	/api/v1/auth/signup	Create user account
POST	/api/v1/auth/signin	Sign in to user account
POST	/api/v1/auth/signup	Create user account
POST	/api/v1/caterer/auth/signup	Create Admin account
POST	/api/v1/caterer/auth/signin	Sign in to Admin account
GET	/api/v1/meals	Get all meals
GET	/api/v1/meals/:mealId	Get a meal
POST	/api/v1/meals	Add new meal
PUT	/api/v1/meals/:mealId	Update or modify meal
DELETE	/api/v1/meals/:mealId	Delete meal
POST	/api/v1/menu	Setup menu
GET	/api/v1/menu	Get menu
GET	/api/v1/orders	Get all orders
POST	/api/v1/orders	Make an order
PUT	/api/v1/orders/:orderId	Modify an order
GET	/api/v1/orders/total	Get total amount from orders of current day
GET	/api/v1/orders/users	Get order for current logged in user
GET	/api/v1/orders/users/:userId	Get order for the user with userId