Project: StudyTracker

StudyTracker is a desktop application for users to keep track of their favourite study spots. The user interacts with it using a CLI, and it has a GUI created with JavaFX. This project was built upon AddressBook - Level 3. It is written in Java, and the team has contributed about 12 kLoC.

Given below are my contributions to the project.

  • New Feature: Amenity feature (charger, food, aircon) together with Danqi
    • What it does: allows the user to add amenities such as wifi, charger, food and aircon to the Study Spots
    • Justification: This feature allows users to filter and list only Study Spots with certain amenities to specifically search for Study Spots with amenities they need.
  • Enhanced Feature: List command
    • What it does: Allow users to list and filter study spots based on specific amenities and/or ratings.
    • Justification: This feature originally allows users to list only based on favourites and tags, however I felt that the functionality was not enough for users as they may want to only list study spots that are rated 5/5 or only study spots that have food if they are feeling hungry.
  • Enhanced Feature: Delete feature
    • What it does: allows the user to delete Study Spots based using the Study Spots’ names, rather than their indexes as per the original AB3
    • Justification: This feature is enhanced to be consistent with all our other commands that only uses the Study Spots’ names rather than their indexes. It is also more intuitive to delete based on names rather than scrolling through the list to find out which index matches to which study spot since names are usually short and easy to remember.
  • Enhanced Feature: Command outputs
    • What it does: Make the outputs displayed to the user more readable and comprehensive across multiple commands
    • Justification: This feature is enhanced so that just the right amount of relevant information is displayed to the users in a user-friendly format so that they are not overwhelmed with information.
  • Enhanced Feature: Help feature
    • What it does: allows the user to visit our User Guide by clicking on a button that opens the link in browser, as compared to the previous version of copying the link to clipboard.
    • Justification: This feature improves the convenience of opening our User Guide.

  • Testing: All the above enhanced/added features, Log Commands

  • Bug-Fixes: For bugs identified during PE-D

  • Code contributed: RepoSense link

  • Documentation:
    • User Guide:
      • Change from passive to active voice throughout the User Guide
      • Add visuals to User Guide to enhance users’ understanding
      • Tweak User Guide according to new or enhanced features
    • Developer Guide:
      • Edited the implementation details and diagram of the delete feature.
      • Edited the details of model diagram.
      • Added a sequence diagram for the amenity feature.
  • Community: