README.md

Fast-Food-Fast

Fast-Food-Fast is a food delivery service app, this is where food sellers meet buyers. Users can order for food from any registered restaurant in the app. Restaurant Admin can add, edit, delete food and manage orders made to their restaurant.

Pivotal Tracker URL

https://www.pivotaltracker.com/n/projects/2196582

Github Repo

https://github.com/jideajayi11/Fast-Food-Fast

UI Template

https://jideajayi11.github.io/Fast-Food-Fast/UI/

API Deployment

APIs

Hosted Application

Goto Application

API Endpoints

HTTP VERB	ENDPOINT	FUNCTIONALITY	REQUEST BODY
GET	/api/v1/orders	Fetch all orders
GET	/api/v1/users/:userId/orders	Fetch user order history
GET	/api/v1/orders/:orderId	Fetch an order
POST	/api/v1/orders	Add an order	quantity, foodId
PUT	/api/v1/orders/:id	Update an order	orderStatus
POST	/api/v1/menu	Add Menu	foodDescription, foodPrice, imageURL
GET	/api/v1/menu	Fetch all Menu
POST	/api/v1/auth/signup	Create Account	fullName, phoneNumber, deliveryAddress, email, password, confirmPassword
POST	/api/v1/auth/login	Login	email, password

Technologies

• Node.js - Runtime Environment
• Express - Web Application Framework
• NPM - Dependency Manager
• Airbnb - Coding Style

Supporting Packages

• ESLint - Linter Tool
• Babel - Transpiles from ES6 to ES5
• Mocha - JavaScript Test Framework for API Tests
• Chai - TDD/BDD Assertion Library for Node
• Istanbul(nyc) - Code Coverage Generator

Features

Orders

• Fetch all Orders
• Fetch an Order
• Add an Order
• Update an Order
• Fetch Order history

Menu

• Add Menu
• Fetch Menu

Users

• Signup
• Signin

Admin

• Signup
• Signin

Extra

• Cancel Order (user)
• Fetch all Restaurant

Installation

• git clone https://github.com/jideajayi11/Fast-Food-Fast
• Run npm install to install packages
• Run npm start to start the server
• Navigate to localhost:3000 in browser to access the application

Tests

• Run npm run test

Author

• Jide Ajayi

License

This project is licensed under the Apache License - see the LICENSE file for details