Project: EduEase

EduEase - EduEase simplifies the management of student contact details, helping private tutors stay organized. It allows them to focus on delivering high-quality teaching while reducing administrative burdens, such as their students’ progress and contacts, thereby enhancing their productivity. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

Given below are my contributions to the project.

  • New Feature: Added the ability to add notes on a student.
    • What it does: Allows user to view, append, overwrite or clear notes of a student.
    • Justification: This feature allows user to remember student’s progress and weakness, enhancing their ability to personalise their lesson plan based on the student ability.

  • Code contributed: RepoSense link

  • Project management:
    • Managed releases v1.3, 1.4, 1.5 (3 releases) on GitHub
  • Enhancements to existing features:
    • Updated PersonCard UI and GUI color scheme
    • Added Confirmation to crucial command like clear to prevent accidental usage
  • Documentation:
    • User Guide:
      • Added detailed instruction on using the note features.
      • Update images from previous AB3 to our new EduEase design
    • Developer Guide:
      • Added implementation details on CommandWithConfirmation, covering the logic with a sequence diagram
      • Added manual testing details for note feature
  • Community:
    • PRs reviewed (with non-trivial review comments):
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
    • Some parts of the history feature I added was adopted by several other classmates (1, 2)

  • Tools:

  • _{you can add/remove categories in the list above}