Fast-Food-Fast

An online food ordering system which allow users register, login and order food items online

Getting Started

These instructions bellow will guide you in getting a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need to have the following softwares installed on your local machine

• node js & npm

Installing

A step by step series of instruction to install and get a development env running

npm install

To start the server run

npm start

Kudos 👍 now your API server is running at http://localhost:3000/

Features

• User can place a new order for food.
• User can get a list of orders.
• User can fetch a specific order.
• User can update the order status.

Running the tests

To run mocha test

npm run test

Endpoints

HTTP verbs	Route Endpoints	Function	Payload
POST	api/v1/auth/signup	Signup user	{ "name": "string", "email": "string", "phone": "string", "password": "string" }
POST	api/v1/auth/login	Login user	{ "email": "string", "password": "string" }
POST	api/v1/menu	Add menu item	{ "name": "string", "category": "string", "description": "text", "price": "number", "image": "text" }
GET	api/v1/menu	Get all menu items	None
PuT	api/v1/menu/:menuId	Updates a specific menu item	{ "name": "string", "category": "string", "description": "text", "price": "number", "image": "text" }
GET	api/v1/menu/:userId/orders	Get all orders of a specific user	None
GET	api/v1/orders	Get all orders	None
GET	api/v1/orders/:orderId	Get a specific order	None
POST	api/v1/orders	Post a user order	{ "address": "string", "foodItems": [ { "foodId": "string", "quantity": "number" }, ... ] }
PUT	api/v1/orders/:orderId	Update order with the given orderId	"status": string

Viewing the UI

To view the UI template, open the UI/index.html or UI/user.html or UI/admin.html from the root directory on your browser

Note: you do not need to start your server when running test, the mocha test run automatically creates an instance of the server on port 3000 and therefore will generate an error when your test tries to create identical server

Credits

Credits@Andela 21 program