Giter Club home page Giter Club logo

brads-burgers-1's Introduction

Brad's Burgers

Table of Contents

Description

For my project, I have created an ordering system for a burger restaurant called Brad's Burgers.

The idea of the ordering system is that when the customer arrives to the restaurant, they will make their order on a terminal.

The customer will first see the home screen which will prompt them to Place Order.

After Place Order has been selected, the screen will show a list of categories to choose from, Burgers, Sides and Drinks.

After selecting a category, the customer will have a choice of selecting from a list of the chosen category.

When the customer has finished with their order, they will see a table on the order page what they have ordered and the total cost.

The customer can remove items from the order list.

When they are happy with the order, the customer can select the Finish Order button which will dirict them to a final page displaying their order number.

The restaurant will then be able to see the orders that have been made along with the order number.

When the order is complete, the restaurant can mark the order as complete.

Back to top


User Stories

As a I want to be able to so that I can
customer select from a number of categories order a meal
customer view what I have ordered see the total price before finishing my order
customer select items from my order remove item from the order list
restaurant worker login to an account edit product information
restaurant worker view orders that have been made along with the order number fulfill an order correctly
restaurant worker mark which orders are complete I don't make the same order twice

Back to top


Wireframe

Homepage

homepage

Order Page

orderpage

Burgers Page

burgerspage

Sides Page

sidespage

Drinks Page

drinkspage

Order Confirmation page

orderconfirmation


Structure

App Flow

Customer

customer

Admin

admin

Back to top


Data Schema

Products

products

Orders

orders

Back to top


Models

Products

Name Key Type Other Details
name CharField max_length=50
price DecimalField max_digits=6, decimal_places=2
image_url URLField max_length=80

Orders

Name Key Type Other Details
number CharField max_length=3
name CharField max_length=100
total DecimalField max_length=10, decimal_places=2, default=0
date DateTimeField auto_now_add=True

Back to top


Features

Existing Features

  • Customer can order their meal by selecting from a number of categories
  • Customer can view what they have ordered with the price of each item and a total price before finishing their order
  • Customer can remove item from order list
  • Customer will be given an order number after finishing their order

Features that I did not get time to add

  • Restaurant can view what orders have been made along side the order number in a dashboard
  • Restaurant can mark which orders have been completed in the dashboard
  • Restaurant can edit and remove items in product management

Future Features

  • Customer can make a payment with debit/credit card after completing order
  • Customer can register their details and order/pay online
  • Customer can have the option for home delivery
  • Restaurant can show what items are out of stock
  • Customer can customize their burger by selecting what they want on it from a number of sub-categories

Back to top


Colors Used

Color Hex Bootstrap name
78c2ad #78C2AD Primary
f3969a #F3969A Secondary
56cc9d #56CC9D Success
6cc3d5 #6CC3D5 Info
ffce67 #FFCE67 Warning
ff7851 #FF7851 Danger
f8f9fa #F8F9FA Light

Back to top


Testing

Back to top

Validator Testing

HTML

File Name File Path Result W3C Error/Warning Comment
base.html /base.html PASS link
index.html home/index.html PASS link
orders.html orders/orders.html PASS link
orders_list.html includes/order_list.html PASS link
burgers.html products/burgers.html PASS link 1 error Fixed
sides.html products/sides.html PASS link
drinks.html products/drinks.html PASS link
product_management.html products/product_management.html
add_burger.html products/add_burger.html
add_side.html products/add_side.html
add_drink.html products/add_drink.html
confirmation.html confirmation/confirmation.html
success.html confirmation/success.html
dashboard.html dashboard/dashboard.html

CSS

File Name File Path Result W3C CSS Error/Warning Comment
base.css orders/base.css PASS link

JS

File Name File Path Result JSHint Comment
main.js orders/main.js PASS link
cart.js orders/cart.js link
orders.js orders/orders.js link

Back to top


Bugs

Issue Comment
#55 File "/workspace/brads-burgers/brads_burgers/settings.py", line 67, in 'DIRS': [TEMPLATES_DIRS], NameError: name 'TEMPLATES_DIRS' is not defined

Fixed Bugs

Issue Commit File Name Line Comment
#55 aff9f79 settings.py 65 changed 'DIRS': [TEMPLATES_DIRS], to 'DIRS': [TEMPLATES_DIR],

Back to top


Deployment

This project was deployed using Heroku

  • Steps for deployment
    • Create a Heroku app
    • Change DEBUG in settings.py to False
    • Link the Heroku app to the repository
    • Click on deploy

Link to deployed site https://brads-burgers.herokuapp.com/

Back to top


Credits

  • Simen Daehlin (mentor) for help and advice
  • Code Institute for the deployment instructions

Back to top


Content

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.