Project: BobTheBistroBoss

Overview

BobTheBistroBoss (BTBB) is a desktop application for home chefs to manage their orders and inventory, optimized for use via a command line interface (CLI).

Summary of Contributions

  • New Feature: Added the ability to add an order. (Pull request #84).
    • What it does: Allows the user to add an order.
    • Justification: The user would want to add orders to BTBB as the orders come in to take note of the client and recipe details. Furthermore, the user would also want to also take note of the order price, order deadline and the order quantity.
    • Highlights: When adding an order, the user can add recipe ingredients. If the ingredients are present in the inventory, it will automatically deduct the appropriate quantity from the inventory depending on the amount used for a particular order.
  • New Feature: Added the ability edit an order. (Pull request #94).
    • What it does: Allows the user to edit an order.
    • Justification: Users might want to make changes to an order after they have added it to BTBB.
    • Highlights: When editing an order, the user can change the order quantity. If the order has recipe ingredients and if they are present in the inventory, it will automatically add or deduct the appropriate quantity from the inventory depending on the changes made to the order quantity.
  • New Feature: Added a bar chart to show the revenue earned for the past twelve months. (Pull request #131).
    • What it does: Allows the user to view their past revenue for the past twelve months in a bar chart format.
    • Justification: This feature allows users to make smarter business decisions depending on their performance for the past twelve months. It also allows the user to easily identity trends and patters in the revenue.
    • Highlights: JavaFX bar chart together with an observable list was used to implement this feature. The bar chart is constantly updated whenever an order is completed.

  • Code contributed: RepoSense link

  • Team tasks:
    • Set up the GitHub organisation and team repository. Enabled pre-push githooks (Pull Request #1).
    • Set up the codebase so that the team can implement new features in a consistent manner and in parallel. (Pull requests #59).
    • Maintain the issue tracker by creating issues, adding labels and closing issues. Created several epic issues for better organization.
  • Review/mentoring contributions:
    • PRs reviewed: #34, #66, #70, #83, #95, #160.
    • Helped team members with implementation questions.
  • Documentation:
    • User Guide:
      • Added user guide for delete recipe. (Pull Request #150).
      • Made user guide more user-centric. (Pull Request #247).
    • Developer Guide:
      • Added use cases. (Pull Request #96).
      • Added implementation details for the adding order. (Pull Request #140).
      • Added some manual testing instructions. (Pull Request #248).
    • General:
      • Added product screenshots (Pull Request #152, #171, #237).
  • Community: