Project: SWEe!

SWEe! is a desktop application used for managing CS2103T learning progress mainly through flashcards. 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.

Code contributed: RepoSense link

Enhancements implemented:

  • Added the ability to add a diagram to the question of a flashcard. #80, #249
    • What it does: allows the user to attach a diagram to the question of a flashcard
    • Justification: This feature allows users who are visual learners to attach a diagram to the question of a flashcard to aid them in their learning.
    • Highlights: This enhancement involves incorporating an image into the application, ensuring that the file exists and its file type is supported by the application as well as making sure it has read permission. Modifications were also made to the add command and edit command to allow the diagram to be added and edited.
  • Added the ability to quiz flashcards. #96
    • What it does: allows the user to enter quiz mode.
    • Justification: This feature allows users to test themselves on their content knowledge and prepare for upcoming examination or quiz.
    • Highlights: This feature involves coding the backend logic of the quiz mode. It also involves monitoring the user attempts in quiz mode to update the flashcard’s statistics.
  • Added statistics command. #106
    • What it does: allows the user to check the statistics of the flashcard.
    • Justification: This feature allows users to check the statistics of the flashcard. The statistics of flashcards are updated from the user’s attempts in quiz mode. Users can see their number of attempts and the number of times they got the answer correct. This allows them to keep track of how well they did and know whether they have mastered the content properly.
    • Highlights: This feature involves coding the backend logic and passing the information to UI so that the statistics can be displayed to the user.
  • Refactor storage to support flashcard storage #42
  • Modified various test cases for classes under the package storage. #42
  • Modified test cases for add and edit commands. #80
  • Added test cases for stats command #106

Contribution to UG:

  • Added documentation for stats and quiz feature #104, #105, #166
  • Added additional details about diagram in add feature #87
  • Edited grammar and language of the document #166, #169
  • Added step by step instructions with images to features and annotated diagrams #169, #215, #239, #276

Contribution to DG:

  • Added add feature implementation and associated diagrams #87, #239

Contribution to Team-Based Tasks:

  • Maintaining the issue-tracker
  • Refactor Java code to remove all instances of AB3 #60
  • Populate application with sample data #211
  • Managed release of v1.3 trial on Github v1.3.trial

Review/mentoring contributions: