Project: JeeqTracker

JeeqTracker is a desktop application created for home-based business owners / resellers that helps them manage the clients that they interact with by keeping track of their BUY / SELL transactions, and REMARKS of clients. It is written in Java, and has about 10 kLoC.

Given below are my contributions to the project.

  • New Feature: Added ability to filter all the transactions by all the clients
    • What it does: allows the user to view all buy or sell transactions made by all the clients.
    • Justification: This feature is useful for the user to look at the buy or sell transactions made by all the clients at one glance.
  • New Feature: Added the create function which was previously used to create a point of contact. The command is now refactored to create a new remark for the specified client.
    • What it does: allows the user to create a new remark that is linked to the specified client
    • Justification: This feature is helpful in allowing users to add remark for a client.
  • New Feature: Added ability to open the user_guide url
    • What it does: allows the user to copy the url of the user guide
    • Justification: This feature is essential for users to access the user guide to learn how to use the application effectively.
  • New Model: Created Transaction Model which includes Transaction, TransactionLog, Goods, Price, Quantity, BuyTransaction and SellTransaction
    • What it does: allow the application to use the model to store the transactions by the clients.
    • Justification: This model is necessary for the creation of the transaction commands.

  • Code contributed: RepoSense link

  • Enhancements to existing features:
    • Added data structure to store all remarks in client model (Pull request #121)
    • Refactored Company to Client class for the entire project (Pull request #159)
    • Added Client Phone and Client Email attributes to client (Pull request #178)
    • Update the help command output messages (Pull request #205)
    • Minor fix to the UI (Pull request #216)
    • Updated help command to not change UI after using (Pull request #217)
    • Fixed input for sort command to allow spaces between the arguments (Pull request #217)
    • Updated error messages for edit, sort, buy and sell commands (Pull request #217)
  • Documentation:
    • User Guide:
      • Edited documentation Create, Add, Help Find commands (Pull requests #69, #70, #146)
      • Added documentation for the Filter, Sort, Delete, User_guide, Remark and Edit commands. Also edited and standardised the user guide for peer user guide review (Pull requests #110, #189, #208)
      • Added documentation for the parameters of sort and create remark commands (Pull request #273)
      • Added links to allow readers to easily return to the table of contents (Pull requests #254, #256, #264)
      • Added About JeeqTracker section in user guide (Pull request #291)
      • Added links in Quick Start section to guide user to download Java (Pull request #291)
    • Developer Guide:
      • Added documentation for the filter command implementation (Pull request #192)
      • Created the activity diagram for the filter command (Pull request #192)
      • Created the sequence diagram for the filter command (Pull request #192)
      • Updated model diagrams (Pull request #297)
      • Added filter in Appendix: Manual testing section (Pull request #297)
      • Added use cases for find/add remark (Pull request #297)
  • Community: