Project: WishfulShrinking

WishfulShrinking is a desktop diet manager refactor from an application called AddressBook-Level 3(AB3). It is used to helps on managing the user’s on-hand ingredients, organise personal recipes and track user’s diet. Wishful Shrinking optimized for fast and efficient typers as it uses a Command Line Interface (CLI) and Graphical User Interface (GUI) created with JavaFX. Wishful Shrinking is available for the Linux, Unix, Windows and Mac OS operating systems.

Given below are my contributions to the project:

  • New Feature 1: Added the Eat Recipe command. (Pull Requests #51)
    • What it does: allows the user “eat” the recipe that is listed in the recipes’ collection.
    • Justification: This feature improves the product as it is the base feature of Wishful Shrinking to help user to keep track of their daily consumption.
    • Highlights: This feature work similar to delete feature. Instead of removing, it copies the specific recipe from recipe list and add the recipe into Consumption List.
    • Credits: AddressBook Level 3 delete feature.
  • New Feature 2: Added List Consumption feature. (Pull Requests #84, #87)
    • What it does: allows the user list the recipes in the Consumption List.
    • Justification: This feature improves the product as it sum up and show the user their calories intake besides from just listing all the recipe ate.
    • Credits: AddressBook Level 3 list feature.
  • New Feature 3: Added Clear Recipe feature. (Pull Requests #170)
    • What it does: allows the user to clear all the recipe in Recipes List.
    • Justification: This feature improves the product because it allows user to start a new Recipe List with a single command instead of repeatedly using deleteR feature.
  • New Feature 4: Added Clear Ingredient feature. (Pull Requests #170)
    • What it does: allows the user to clear all the ingredient in Fridge (Ingredient List).
    • Justification: This feature improves the product because it allows user to start a new “Fridge” with a single command instead of repeatedly using deleteF feature.
  • New Feature 5: Added Clear Consumption feature. (Pull Requests #170)
    • What it does: allows the user to clear their daily consumption in Consumption List.
    • Justification: This feature improves the product because it allows user to start a new Consumption List with a single command instead of repeatedly using deleteC feature.
  • Code contributed: RepoSense link
  • Project management:
    • Produce shadowJar file for test and release v1.2.
    • Setting up group meeting for discussion.
    • Remind team members to approve members’ PRs.
  • Enhancements to existing features:
    • Refactored Search Recipe feature from find feature in AddressBook Level 3. (Pull Requests #37)
    • Added Calories field into Recipe for Eat Recipe feature. (Pull Requests #80)
    • Updated the GUI to list out consumption. (Pull Requests #88)
    • Refactored Sample Test in AddressBook Level 3 to fit the current Wishful Shrinking. (Pull Requests #111)
    • Resolved most the tests that failed when we commented out while refactoring feature from AddressBook Level 3. (Pull Requests #111)
    • Added tests for Search Recipe feature and Recommand feature. (Pull Requests #116)
  • Documentation:
    • User Guide:
      • Transfer the user guide’s draft from google document to UserGuide.md: #31
      • Updated add Recipe documentation: #117
      • Added documentation for the features eatR, calories, clearR, clearF and clearC: (#51, #117, #170)
      • Added break page for pdf converting purpose: #294
    • Developer Guide:
      • Added implementation details and sequence diagrams of eat Recipe, list Consumption, select Recipe and clear feature: #117
      • Combined the implementation of the similar feature e.g. combine list Consumption, list Recipe and list Ingredient to list: #181
      • Added the table of content in Developer Guide: #245
      • Added activity diagram for clear and eat Recipe features: #261
      • Updated Class Diagrams(Model Component): #252
      • Added break page for pdf converting purpose: #294
  • Community:
    • PRs reviewed (with non-trivial review comments): #172, #178, #24
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)