Pizza

Objectives

• Become more comfortable with Django.
• Gain experience with relational database design.

Getting Help

If you need help while working on the project, feel free to take advantage of any or all of the following resources:

• Attend one or more of the course’s sections.
• Ask questions on the course’s discussion forum.
• Attend office hours.

Overview

In this project, you’ll build an web application for handling a pizza restaurant’s online orders. Users will be able to browse the restaurant’s menu, add items to their cart, and submit their orders. Meanwhile, the restaurant owners will be able to add and update menu items, and view orders that have been placed.

Milestones

The project is due on November 21, but we recommend that you try to meet the following milestones. Note that these milestones are only recommendations, the only official deadline for this project is the final one:

• Complete the Menu, Adding Items, and Registration/Login/Logout steps by November 8.
• Complete the Shopping Cart and Placing an Order steps by November 15.
• Complete the Viewing Orders and Personal Touch steps by November 21.

Getting Started

GitHub Classroom

We’ll again use GitHub Classroom to distribute projects and collect submissions. To begin Project 3:

1. Click here to go to the GitHub Classroom page for starting the assignment.
2. Click the green “Accept this assignment” button. This will create a GitHub repository for your project. Recall that a git repository is just a location where your code will be stored and which can be used to keep track of changes you make to your code over time.
3. Click on the link that follows “Your assignment has been created here”, which will direct you to the GitHub repository page for your project. It may take a few seconds for GitHub to finish creating your repository.
4. In the upper-right corner of the repository page, click the “Fork” button, and then (if prompted) click on your username. This will create a fork of your project repository, a version of the repository that belongs to your GitHub account.
5. Now, you should be looking at a GitHub repository titled username/project3-username, where username is your GitHub username. This will be the repository to which you will push all of your code while working on your project. When working on the project, do not directly push to the web50/project3-username repository: always push your code to your username/project3-username repository.

Python and Django

As with Projects 1 and 2, make sure that you have a copy of Python 3.6 or higher installed on your machine. You’ll also need to install pip. If you downloaded Python from Python’s website, you likely already have pip installed (you can check by running pip in a terminal window). If you don’t have it installed, be sure to install it before moving on!

To run this Django application:

1. Clone your username/project3-username repository from GitHub (note: this is NOT your web50/project3-username repository).
2. In a terminal window, navigate into your project3 directory. Note that this is the directory for a Django project called pizza, inside of which is an app already created for you called orders.
3. Run pip3 install -r requirements.txt in your terminal window to make sure that all of the necessary Python packages (Django, in this instance) are installed.
4. Run python manage.py runserver to start up your Django application.
5. If you navigate to the URL provided by Django, you should see the text "Project 3: TODO"!

Requirements

Alright, it’s time to actually build your web application! Here are the requirements:

• Menu: Your web application should support all of the available menu items for Pinnochio’s Pizza & Subs (a popular pizza place in Cambridge). It’s up to you, based on analyzing the menu and the various types of possible ordered items (small vs. large, toppings, additions, etc.) to decide how to construct your models to best represent the information. Add your models to orders/models.py, make the necessary migration files, and apply those migrations.
• Adding Items: Using Django Admin, site administrators (restaurant owners) should be able to add, update, and remove items on the menu. Add all of the items from the Pinnochio’s menu into your database using either the Admin UI or by running Python commands in Django’s shell.
• Registration, Login, Logout: Site users (customers) should be able to register for your web application with a username, password, first name, last name, and email address. Customers should then be able to log in and log out of your website.
• Shopping Cart: Once logged in, users should see a representation of the restaurant’s menu, where they can add items (along with toppings or extras, if appropriate) to their virtual “shopping cart.” The contents of the shopping should be saved even if a user closes the window, or logs out and logs back in again.
• Placing an Order: Once there is at least one item in a user’s shopping cart, they should be able to place an order, whereby the user is asked to confirm the items in the shopping cart, and the total (no need to worry about tax!) before placing an order.
• Viewing Orders: Site administrators should have access to a page where they can view any orders that have already been placed.
• Personal Touch: Add at least one additional feature of your choosing to the web application. Possibilities include: allowing site administrators to mark orders as complete and allowing users to see the status of their pending or completed orders, integrating with the Stripe API to allow users to actually use a credit card to make a purchase during checkout, or supporting sending users a confirmation email once their purchase is complete. If you need to use any credentials (like passwords or API credentials) for your personal touch, be sure not to store any credentials in your source code, better to use environment variables!
• In README.md, include a short writeup describing your project, what’s contained in each file you created or modified, and (optionally) any other additional information the staff should know about your project. Also, include a description of your personal touch and what you chose to add to the project.
• If you’ve added any Python packages that need to be installed in order to run your web application, be sure to add them to requirements.txt!

Beyond these requirements, the design, look, and feel of the website are up to you! You’re also welcome to add additional features to your website, so long as you meet the requirements laid out in the above specification!

Hints

• Unlike in Project 1, you shouldn’t need to build your application’s entire login and authentication system yourself. Feel free to use Django’s built-in users and authentication system to simplify the process of logging users in and out.
• Before diving into writing your models, you’ll likely want to think carefully about the different types of menu items and how best to organize them. Some questions to consider include: how should you represent the different prices for large and small versions of the same dish? Where do toppings fit into your model for pizzas, and how do you calculate the ultimate price of a pizza? How will you make the custom add-ons for the subs work?

FAQs

What is a “Special” pizza?

It’s up to you to decide what a “special” pizza means, and to implement it accordingly. It could be one particular set of toppings, allowing up to 5 different types of toppings, or something else entirely!

How to Submit

Step 1 of 2

1. Go to the GitHub page for your username/project3-username repository (note: this is different from the web50/project3-username repository).
2. On the right side of the screen, click the Pull request button.
3. Make sure that the “base fork” is web50/project3-username, and the “head fork” is username/project3-username.
4. Click “Create pull request”.
5. On the next page, click the “Create pull request” button again.

Step 2 of 2

Fill out this form!

Congratulations! You’ve completed Project 3.