StockPal

Leong Xing Yu’s - Project Portfolio Page

Overview

StockPal is an inventory management application, designed to help small business owners like you to manage your stock-taking effectively.

StockPal is a command line interface (CLI), which means that it is run using a text-based interface such as the Command Terminal on windows or Terminal on MAC.

Summary of Contributions

Code Contributed

Link to my code

Features implemented

1. Inflow Command Feature

#31

What it does:

This feature enables user to increase the quantity of the specified product whenever there is an increase in stock.

Justification:

This feature is essential to StockPal, an inventory management app, to keep track of user’s stock efficiently.
A user will be able to keep track of their current inventory easily and prevent excess inventories.


2. Outflow Command Feature

#31

What it does:

This feature enables user to decrease the quantity of the specified product whenever there stocks are sold.

Justification:

This feature is essential to StockPal, an inventory management app, to keep track of user’s stock efficiently.
A user will be able to keep track of their current inventory easily and prevent issues like overselling.

3. Notification of Low Quantity Products

#51

What it does:

This feature will notify the user when the quantity first dips below the threshold quantity (Threshold Quantity: 20).
A list of Low Quantity Products will be shown when the StockPal exits.

Justification:

The feature is essential to StockPal as we want our users to be notified when their products are running low.
This will prevent situations such as ‘Out of Stock’.

Enhancements for Existing Features

Wrote unit testing for Inflow and Outflow Commands. #31

Contributions to the UG

Added documentation for the features inflow and outflow. #89

Contributions to the DG

Added documentations for the features inflow and outflow. Added sequence diagrams for the respective features as well. #76

Contributions to Team-based Tasks

Contribution Beyond the Project Team