Project: Gim

  • Gim is a desktop app for managing gym exercises, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Gim allows you to keep track your exercises and Personal Records in an efficient way.

Given below are my contributions to the project.

  • New Feature: Recognised Exercises list in bottom right of the GUI (PR #107)
    • What it does: Provides User with an idea of what unique exercises they have inputted in the system, updated in real time.
    • Justification: This is especially important when the exercise list is populated/ the user has been using the app for a long time. He may accidentally misspell an exercise name when keying it in, causing the system to miss out on a potential personal record/entry.
    • Highlights:
      • Added Exercise Keys Class which handles logic behind ExerciseHashMap keys.
      • Used Observer Pattern design in facilitating real time interaction between ExerciseHashMap and UI.
      • Update ExerciseHashMap with relevant methods and fields to support Observer pattern.
      • Conducted testing (specifically for ExerciseKeys class and added onto ExerciseHashMap Tests) while designing the feature such that code coverage remained consistent (no change in coverage after push).

  • Code contributed: RepoSense Link

  • Project management:
    • Managed issue tracker for v1.3 and v1.4
  • Enhancements to existing features:
    • Redesigned Help Window (PR #115, PR #141, PR #142)
      • What I did:
        • Help window now provides a brief summary of available commands on top of a link to the user guide
      • Justification:
        • Provides convenience as users can now get some basic help in the help window instead of being redirected to the user guide. This enhancement saves clicks and time in the long run.
    • Redesigned User Interface (PR #84, PR #94, PR #116)
      • What I did:
        • Moved Result Display window to the right and added Saved Exercises List window.
      • Justification:
        • For moving the Result Display window and adding the Saved Exercises List window, the previous UI had a lot of wasted real estate as the cards were taking up a lot of space. Furthermore, the result display window was too small and needed to scroll, especially when a long error message came up, which was inconvenient.
      • What I did:
        • Separated Date as a standalone label in the Exercise Card UI.
      • Justification:
        • The date of an exercise is especially important when keeping track of progress, hence making sure it is easily visible and distinct from the rest of the fields is important.
    • Added Reps as a field to the creation of an Exercise. (PR #67)
      • In charge of REGEX and operations relating to reps
    • Removing edit feature and tests relating to it (PR #127)
  • Documentation:
    • User Guide:
      • Standardised pictures in User guide, included callouts for important information in each picture. (PR #202).
      • Wrote entire section for GUI orientation.
      • Helped with formatting of commands (placement of tips, phrasing of parameter constraints).
    • Developer Guide:
      • Wrote section on listing of unique stored Exercises in the graphical UI (PR #216, PR #102)
      • Added UML diagrams (class and sequence diagrams) for recognised exercise list implementation.
      • Added User stories as discussed.
  • Contribution to team-based tasks:
    • Reviewed Team Member’s PRs and provided feedback where appropriate.
    • PED bugs triaging.
  • Tools:
    • PlantUML: Creating UML diagrams.
    • SceneBuilder: Edit FXML files which Gim UI components use.