Fast-Food-Fast

Fast-Food-Fast is a food delivery service app for a restaurant. A user can create an account, signin to the account and make orders for food items.

UI hosted on gh pages

https://davidshare.github.io/Fast-Food-Fast/UI/index.html

Server side hosted on Heroku

https://fast-food-fast-essien.herokuapp.com/

API Documentation

https://fast-food-fast-essien.herokuapp.com/api-docs

Table of Content

• Getting Started

• Prerequisites for installation

• Installation

• Test

• API End Points Test Using Postman

• Coding Style

• Features

• Built With

• Author

• License

• Acknowledgement

Getting Started

Prerequisites for installation

1. Node js
2. Express
3. Git

Installation

1. Clone this repository into your local machine:

e.g git clone https://github.com/davidshare/Fast-Food-Fast

2. Install dependencies

e.g npm install.

3. Start the application by running the start script.

e.g npm start

4. Install postman to test all endpoints on port 3000.

Test

run test using 'npm test'.

API End Points Test Using Postman

HTTP VERB	ENDPOINT	FUNCTIONALITY
POST	/api/v1/auth/signup	User signup
POST	/api/v1/auth/login	User signin
POST	/api/v1/menu	Add a meal
POST	/api/v1/orders	Posts a order
PUT	/api/v1/orders/:orderId	Updates the status of an order
PUT	/api/v1/menu/:mealId	Updates a meal
GET	/api/v1/menu	Get menu
GET	/api/v1/menu/:mealId	Get a meal by mealId
GET	/api/v1/orders	Gets all orders
GET	/api/v1/orders/:orderId	Gets an order by orderId
GET	/api/v1/users	Gets all users
GET	/api/v1/users/{userId}/orders	Gets a user's order history
DELETE	/api/v1/menu/:mealId	Delete a meal
DELETE	/api/v1/users	Delete all users that are not admin

Coding Style

• Airbnb style guide.

Features

Admin

• Admins can add food items
• Admins can edit food items
• Admins can delete food items
• Admins can see food orders
• Admins can decline food orders
• Admins can mark food orders as completed

Users

• A user can create an account
• A user can signin to his/her account
• A user can view available food items
• A user can make orders and cancel the orders
• A user can see history of orders

Built With

• NodeJs-EXPRESS: Node.js is a javascript runtime built on Chrome's V8 javascript engine.

• html5: It is used for structuring the frontend.

• css: It is used for styling the frontend.

• Vannila Javascript: It is used for scripting the client side.

Author

• David Essien

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details.

Acknowledgement

I acknowledge the individuals from the organisation and groups below. They were a great source of motivation in completing this project.

• Andela.
• Andela Learning Facilitators.
• Andela 21