Project: Warenager

Warenager is an inventory application to help tech-savvy warehouse managers to keep track of items in their warehouse. It optimizes management tasks for warehouse managers including but not exhaustive of updating, searching and ordering supplies, via Command Line Interface (CLI).

Given below are my contributions to the project.

  • Code Contribution
    • Here is a link to my code on the tP Code DashBoard.
  • Enhancement Implemented
    • New Feature: Added the ability to list existing items in the storage. (Pull Request #116)
      • What it does: Allows the user to view the desired stocks.
      • Justification: This feature improves the user experience as user can easily view the details of the desired stocks. Users can now view the desired stocks quickly and conveniently, by using any of the fields (all, bookmark, low) to find stocks that are bookmarked or low in quantity or all stocks respectively.
      • Highlights: This feature enables the user to view all stocks, or bookmarked stocks or stocks with low quantity.
    • New Feature: Added the ability to bookmark and unbookmark existing items in the storage. (Pull Request #150, #155)
      • What it does: Allows the user to bookmark the desired stocks.
      • Justification: This feature improves the user experience as user can bookmark the stocks so as to push the stock to the top of stock for easier viewing. The user can also remove the priority from the bookmarked stocks once the user deem the importance of the stock is reduced. This way the other stocks not bookmarked can be seen as well.
      • Highlights: This feature coupled with the list feature allows the user to view all the bookmarked stocks. It also enables the user to unbookmark the stock if the user makes a mistake or when the user deems that the stock is of less importance.
    • New Feature: Added the ability for the user to find help. (Pull Request #99, #106, #132)
      • What it does: Allows the user to get help.
      • Justification: This feature improves the user experience as the user is able to use this feature to find out more about how the commands in Warenager can be used, should the user be unsure of how to use the commands. The help window also allows the user to view the user guide for more detailed help.
      • Highlights: This feature enables the user to seek help when using Warenager.
  • Testing: (Pull Request #155 #271 #291 #309)
    • Created tests for bookmark feature (bookmarkCommandParser, bookmarkCommand).
    • Created tests for unbookmark feature (unbookmark command parser, unbookmark command).
    • Created tests for help feature (helpCommandParser, helpCommand).
    • Improved coverage by creating tests for LogicManager and ArgumentTokenizer.
  • Documentation:
    • User Guide: (Pull Request #176, #179, #210, #263)
      • Added documentation for the feature bookmark.
      • Added documentation for the feature unbookmark.
      • Added documentation for the feature list.
      • Added documentation for the feature help.
      • Added components of GUI into the UG.
      • Fix markdown formatting errors.
    • Developer Guide: (Pull Request #281)
      • Added implementation details of the bookmark feature.
      • Added implementation details of the unbookmark feature.
      • Added implementation details of the list feature.
      • Added implementation details of the help feature.
      • Added class diagrams for UI.
      • Added UML diagrams for bookmark, unbookmark feature.
  • UI: (Pull Request #114 #150 #207)
    • Came up with the design and colour scheme of the UI (stockTable, resultDisplay, commandBox and enterButton).
    • Updated the help window to include a summary table and a clickable link.
  • Git & Repository:
    • Used GitHub Projects feature to create kanban boards to track user stories.
    • Used Github commit to inform my groupmates of updated that I did.
  • Reviews & Merging:
    • Helped to review pull requests.
    • Helped to merge approved pull requests after thorough review and GitHub action checks.