Project: Inventory Book (OneShelf)

OneShelf is an app designed as a one-stop platform for restaurant managers to handle their management needs such as having efficient inventory management and up-to-date information on pending deliveries, which translates to savings in man-hours and minimal losses due to over stocking.

Given below are my contributions to the project.

  • Code contributed: RepoSense link

  • Project management:
    • Managed releases v1.1, v1.2, v1.2b, v1.3, v1.4 on GitHub
  • Added help and preview window: Help window and summary command window.
    • What it does: Allows users to have easy reference when they want to start learning OneShelf.
    • Justification: As OneShelf have a relatively steep learning curve, it is good to have a good guidance at the start to ensure that user can get accustomed to the features easily.
    • (Pull Request #80, #81, #90)
  • Added dynamic clock: Allows user to see clock instead of storage on bottom left corner of application.
    • What it does: Shows users a more useful information (current date time).
    • Justification: A restaurant manager would be more concerned with current time and date rather than the storage data location.
    • (Pull Request #143)
  • Added delivery commands: Allows user to input commands for delivery, specifically are: list-d, clear-d, delete-d and edit-d.
    • What it does: Allows delivery features to work for users.
    • Justification: A restaurant manager would want to be able to list, clear, delete and edit deliveries.
    • (Pull Request #99)
  • Enhancements to existing features:
    • Updated the GUI layout draft 1 (Pull requests #42, #63)
    • Added unit and integration tests for remove command (#79, #109)
    • Added delivery model test cases (#122)
  • Documentation:
    • General:
      • Initial Project Readme set up to match our project
      • Planned and wireframed UI Mock Up using Figma (#63)
      • Updated Ui.png in v1.3
    • User Guide:
      • Added documentation for the features clear, edit, help in v1.1
      • Updated documentation for the features clear-i, clear-d, list-i, list-d in v1.2
      • Added numberings, introduction, GUI annotated diagram, quick start installation guide video, FAQ in v1.3
      • Updated documentation for add-i, add-d, help start and help summary, delete-i, delete-d in v1.3
      • Added/ Updated Installation Guide, How to Use OneShelf, User Interface sections.
    • Developer Guide:
      • Added introduction with target audience, purpose of document and summary of document
      • Added Use Cases and Manual Testing
      • Redesigned UI UML diagram
      • Updated Glossary
      • Provided description for all components before Diagrams and standardize Figure numbers
      • Added description for structures of Item and Delivery
      • Added Help Window implementation with description, code snippet and Activity diagram
      • Restructure DG: Logging, configuration, appendices
  • Community:
  • Tools:
    • Integrated GitHub Actions CI/CD tools for the team
    • Integrated a new Github plugin (ZenHub) during meeting to the team
    • Set up GitHub Organization and Team Repo
    • Added Code Coverage badge for the team and integrate with CI for v1.2 iteration