Project: EduTrack

EduTrack is a powerful desktop app designed for SOC tutors. It allows them to streamline their teaching tasks and effortlessly track their class and student records. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java and has about 12 kLoC.

Given below are my contributions to EduTrack.

  • New Features:

    • Added the ability to remove a student from his or her class.

      • What it does
        It allows users to easily remove a student from their class.
      • Justification
        This feature streamlines class roster updates. It is useful when a student leaves the class and is no longer under the user or when the user allocates a student to a class wrongly.

    • Added the ability to simulate the start of a lesson.

      • What it does
        It helps users to update multiple class records when initiating a new lesson. It automatically increments the total lesson count and resets the attendance sheet for marking student attendance.
      • Justification
        This feature streamlines class record updates, eliminating the need for multiple manual commands.

    • Added the ability to manually set the number of lessons conducted for a class.

      • What it does
        It allows users to set the specific number of lessons conducted for a class.
      • Justification
        EduTrack can track the number of lessons conducted for a class by the number of times the Start Lesson command is used. However, if the user unintentionally uses Start Lesson command, this allows the user to correct the number of lessons conducted easily.

  • Code contributed: RepoSense link

  • Enhancements to existing features:

    • Wrote tests for existing features to increase coverage by

  • Documentation:

    • User Guide:
      1. Added and updated documentation of the feature removing a student: #25, #64, #67
      2. Added and updated documentation of the feature starting a lesson: #64, #67
      3. Added and updated documentation of the feature setting number of lessons of a class: #85
      4. Tweaked documentation of command format from original UserGuide: #25
      5. Improve user-centricity and tone: #151
      6. Improve grammar for final submission : #161
    • Developer Guide:
      1. Added UML diagrams for implementation of Remove Student feature: #56, #64, #67, #144
      2. Added and updated use cases for Remove a student, Modify an existing student record, and Use auto-save feature: #25, #151
      3. Adjusted the description and UML diagram for Storage Component #151
      4. Improve grammar for final submission : #161

  • Contribution to team:

    • Responsible for overall project coordination
      • Setting agendas for weekly meet-ups
      • Preparing skeletal documentation before discussions

  • Community:

    • PRs reviewed (with non-trivial review comments): #88, #61, #40, #36
    • Reported bugs & flaws with extensive elaboration to ease the process of bug fixing for another team (taken from Practical Exam Dry Run).

  • Key Contributions to the Developer Guide: