Supreme Slices Pizza Management System

Description

The Supreme Slices Pizza Management System is a web application designed to streamline the management of pizzas and toppings in a restaurant setting. It provides features for Chefs to create, update, and delete pizzas, as well as Owners to manage toppings. Access to both the Chef and Owner dashboards are user-authenticated and therefore prevent non-management users from accessing and editing the system.

Table of Contents

• User Stories
• Installation
• Usage
• Login Information
• Running Tests
• Access Remote Application
• Technical Choices
• Author
• License

User Stories

Manage Toppings

As a pizza store owner, I should be able to manage the toppings available for my pizza chefs.

• It should allow me to see a list of available toppings.
• It should allow me to add a new topping.
• It should allow me to delete an existing topping.
• It should allow me to update an existing topping.
• It should not allow me to enter duplicate toppings.

Manage Pizzas

As a pizza chef, I should be able to create new pizza masterpieces.

• It should allow me to see a list of existing pizzas and their toppings.
• It should allow me to create a new pizza and add toppings to it.
• It should allow me to delete an existing pizza.
• It should allow me to update an existing pizza.
• It should allow me to update toppings on an existing pizza.
• It should not allow me to enter duplicate pizzas.

Installation

To install the Pizza Management System locally, follow these steps:

1. Clone the repository to your local machine:

   git clone https://github.com/your-username/pizza-management.git

2. Navigate to the project directory:

   cd pizza-management

3. Create a virtual environment (optional but recommended):

   python -m venv venv

4. Activate the virtual environment:
   • On Windows:

     venv\Scripts\activate

   • On macOS and Linux:

     source venv/bin/activate

5. Install the project dependencies:

   pip install -r requirements.txt

6. Make any new database migrations:

   python manage.py makemigrations

7. Apply the database migrations:

   python manage.py migrate
   

Usage

To run the Pizza Management System locally, execute the following command making sure you are in the project's root directory:

python manage.py runserver

Then, access the application in your web browser at http://localhost:8000.

Login Information

To access the Chef and Owner dashboards, use the following credentials to log in:

• Chef
  • Username: Chef
  • Password: SupremeSlicesChef
• Owner:
  • Username: Owner
  • Password: SupremeSlicesOwner

If you do not log in, you will not be able to access the dashboards.

Running Tests

To run tests for the Pizza Management System locally, use the following commands:

Make sure you are in the project's root directory and virtual environment. \path\to\full-stack-developer\pizzaManagement\

• Run Chef Dashboard Tests

  python manage.py test Chef

• Run Owner Dashboard Tests

  python manage.py test Owner

  These commands will execute all the tests within the respective Chef and Owner apps in the project and display the results in the terminal.

Access Remote Application

Supreme Slices Management Dashboard

• http://52.14.211.46:8000/
• Hosted with AWS EC2 Free Tier

Technical Choices

Overview

The application was built using Django, a high-level Python web framework, due to its robust features, built-in security mechanisms, and rapid development capabilities. For the front end, Bootstrap was chosen for its simplicity and ease of use in creating responsive web interfaces. The application follows the 3-tier Model-View-Template (MVT) architecture pattern provided by Django, which promotes code organization and separation of concerns. It utilizes Django's built-in authentication system for user management and authorization as well as the built-in Database Management System.

Languages

• Python
• HTML, CSS, Javascript

Database Management

Django supports multiple database backends, including SQLite, PostgreSQL, MySQL, and Oracle. For this project, SQLite was chosen as the default database during development due to its simplicity and ease of setup. As per the requirements, the data storage solution uses a server-side database to maintain state.

Authentication and Authorization

Django's built-in authentication system was utilized for user management, authentication, and authorization. This system provides secure authentication mechanisms such as password hashing, session management, and user permissions. It also integrates seamlessly with Django's admin interface, allowing administrators to manage users, groups, and permissions easily.

Hosting Service

The Pizza Management System is deployed on AWS EC2 Free Tier. AWS EC2 was chosen for its reliability, scalability, and cost-effectiveness.

Author

This project was created by Sami Tanquary. It is intended for use by StrongMind as a part of the Full Stack Developer technical interview.

License

This project is licensed under the MIT License.