Party Pantry
Table of Contents
- Overview
- User Guide
- Development History
- Acceptance Testing
- Developer Guide
- Team Contract
- Team Members
Overview
Party Pantry is a web application that serves as an inventory management system of one’s pantry in multiple locations (i.e. multiple homes containing one or more freezers, refrigerators, spice racks, etc.) The app allows users to keep track and update current items in their kitchen. Party Pantry allows users to add ‘Storage Spaces’, where they can then add any corresponding items.
User Guide / Page Mockups
This section provides a walkthrough of the Party Pantry web app including its user interface and its capabilities.
Landing Page
Here is the landing page of our Party Pantry app!
Sign up Page
Here you can sign up and create an account to start using Party Pantry!
Sign in Page
Here you can sign in to your Party Pantry account.
‘My Kitchen’ Page
Once you sign up or sign in, you will be brought to the ‘My Kitchen’ page, where you can see an overview of your kitchen - you will see all of your storage spaces and items.
Shopping List
Here you can see a generated shopping list - provided are all the items you are out of or running low on. You will also see a total amount of money that is predicted that you will have to spend if you buy all of the items on the shopping list.
Recipes Page
This page shows all of the possible recipes you can make with the ingredients you currently have in your pantry. Any ingredients that are missing to make the recipe can be added to your shopping list in the “Shopping List” page. We are planning to add functionality to add in your own custom recipes.
Development History
The following describes the process of building the app from the design process to code implementation and deployment. Our progress is as follows:
Milestone 1: Identifying Basic User Needs (User Stories) & Mockup Page Development
The goal of Milestone 1 was to create a work flow for the app to identify its main features to solve the problem of keeping track of supplies and managing ingredient usage. We focused on creating a mockup of the app’s UI.
Milestone 1 was managed using Party Pantry GitHub Project Board M1
Milestone 2: Basic Skeleton of All Pages, Finalize Database Model, User Authentication
The goal of Milestone 2 was to create all the basic components of the app. For backend, this included implementing all the relational databases properly and ensuring that functionalities for adding and editing storage spaces/ ingredients work properly. For frontend, we will focus on creating simple layouts for all the webpages and check that all web pages and nav links in the menu bar navigate correctly based on an authenticated user.
Milestone 2 was managed using Party Pantry GitHub Project Board M2
Milestone 3: Improving Functionality, Project Organization, and Acceptance Testing
The goal of Milestone 3 is to have more functionality and user interactivity with forms and searching features for the My-Kitchen page. Our team is aiming to try to incorporate all data into our database for the Shopping-List and Recipes pages. We will also be continuing with acceptance tests for each of our pages.
Milestone 3 was managed using Party Pantry GitHub Project Board M3
Acceptance Testing
The following are screenshots of our basic acceptance testing for Pantry Pantry. We used Playwright to run our acceptance tests:
Developer Guide
Continuous Integration
Party Pantry uses GitHub Actions to automatically run ESLint and Playwright tests each time a commit is made to the default branch. You can see the results of all recent “workflows” at https://github.com/party-pantry/pantry-party/actions.
The workflow definition file is located at .github/workflows/ci.yml.
Team Contract
Link to Team Contract (will open in Google Docs).
Team Members
Party Pantry is designed and developed by: