alexlim510 - Project Portfolio Page

Project - Exam Study Companion (ESC)

Overview

Exam Study Companion (ESC) is a command-line based app that is designed to help students preparing for upcoming exams. The app is written in Java and requires JDK 11 to run.

Summary of Contributions

Code Contributed

https://nus-cs2113-ay1920s2.github.io/tp-dashboard/#breakdown=true&search=alexlim510

Enhancements Implemented

• Major enhancement: added the ability to parse user inputs
  • What it does: Parses the user inputs into the correct parameters for the corresponding commands.
  • Justification: The application must be able to process user inputs so as to produce the desired outcome.
  • Highlights: This enhancement affects all commands in the application. Extensive exception handling is required to prevent users from making erroneous inputs.
• Major enhancement: implemented the general structure of the command classes
  • What it does: The command classes follow a structured inheritance hierarchy system with the required attributes and methods.
  • Justification: To improve the code for maintenance, integration and testing, it should follow certain OOP principles such as the single responsibility principle.
  • Highlights: This enhancement can ease the maintenance of the code. Moreover, the addition of new commands also become easier with the help of the open close principle.

Contributions to the UG

• Added screenshots of UI

Contributions to the DG

• Contributed to section 1. Design and 2.1.[Proposed] Subject Feature
• Added figures 1, 2, 3, 4, 6 and 7

Contributions to Team-based Tasks

• Helped to maintain the issue tracker
• Reviewed code by other team members when required