Jeremy733 - 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

Major Enhancement: Added the subject/subjectlist class

• What it does: allows user to store a subject tag to each card added and has the ability to add, delete and list subjects.

• Justification: This feature improves the product because in real life, revision is done according to subjects.

• Highlights: This enhancement needs to work along side the Card/Cardlist class which alrealy exists. It needs to limit the access to Card/Cardlist class as well to conform with the design.

Major Enhancement: Added the editCardCommand class

• What it does: allows user to edit an existing card.

• Justification: The feature improves usability as users can now edit a card instead of removing it and add a new one.

• Highlights: This enhancement has a new format of inputs therefore existing functions to extract data from the command needs to be adjusted.

Major Enhancement: added the UI class

• What it does: allows user to have easier interaction with the app.

• Justification: This feature was done originally in one class. Then it was separated into different classes to shorten the length of code needed.

• Highlights: The messages follows each command was later moved to respective classes to avoid lengthy code.

Minor Enhancement: Added the view of answers when listing.

Minor Enhancement: Added the ability to detect duplicates in subjects

Contributions to Documentation

Contributions to the DG

• Added user stories
• Added the architecture write-up section.
• Added test appendix

Contributions to the UG

• Added FAQ section and edited feature section according to latest codes.
• Added screenshots to some features.

Code Contributed : Code

Contributions Beyond the Project Team

• Bug fixes and minor improvements for existing features.