tp

Cai Jiali’s Project Portfolio Page

Project: PantryPal

PantryPal is an all-in-one application designed to help students manage their meals. The application allows users to keep track of their ingredients, automatically generate shopping lists, plan their meals, and store recipes.

Code Contributed

• Shopping List Feature:
  I contributed all code related to the shopping list functionality. This includes:
  • The ShoppingList class, which manages the collection of shopping list items and supports operations such as add, remove, update, edit, and mark as purchased.
  • The ShoppingListItem class, which represents a single shopping list entry. This class ensures proper formatting and supports a purchased flag.
  • The ShoppingListGenerator class, which auto-generates the shopping list by comparing low-stock alerts from the Ingredient Inventory with current stock levels.
• Testing classes for shopping list
  • I created and maintained JUnit tests to ensure all functionalities of the ShoppingList ShoppingListItem were thoroughly tested.
• Command classes for shopping list related command
  • Integrates shopping list related classes seamlessly with the main UI.
• Link to my code on tP Code Dashboard

Enhancements Implemented

Shopping List Item Enhancements

• What it does:
  Implements a robust ShoppingListItem class that encapsulates an ingredient’s name, quantity, unit, and a flag indicating if the item is purchased.
• Why it is implemented that way:
  To ensure each shopping list entry is self-contained, easily editable, and clearly displayed (with quantities formatted appropriately).
• Highlights:
  The use of a copy constructor for deep copying and assert statements for data validation enhances code reliability.

Shopping List Functionality Enhancements

• What it does:
  The ShoppingList class supports operations to add, remove, update, and edit items, as well as mark items as purchased. This gives users flexible control over their shopping list.
• Why it is implemented that way:
  The design follows the Single Responsibility Principle, separating item management from list-level operations. This makes the code modular and extensible.
• Highlights:
  Integration of an index-based edit function allows users to easily modify items, and the “mark as purchased” feature visually tracks completed items.

Documentation:

User Guide:

• Added documentation for shopping list features:
  • Adding items to shopping list
  • Updating shopping list items
  • Clearing shopping list
  • Automatic low-stock detection
• Update command summary table with updated shopping list features

Developer Guide:

• Completed the implementation of the shopping list item and shopping list features
• Created sequence diagrams for the shopping list item and shopping list features.
• Added detailed descriptions on the design and implementation of the shopping list item and shopping list features.

Project Management:

• Set up Gradle build system
• Configured testing framework
• Helped to test team members’ code and created issues tracking
• Provided feedback on implementation approaches
• Helped resolve merge conflicts