tp

Jin Xuan Ow Yong - Project Portfolio Page

Overview

PocketPal is a user-friendly money-management app that makes it easy to track expenses. With a command-line interface, users can quickly log and access their expenses, and categorize them by type. Users can also easily filter expenses based on date, category and price range. Overall, PocketPal is a convenient tool for managing your expenses.

Summary of Contributions

Given below are my contributions to the project.

1. Implemented data structure used to perform main application logic (EntryLog)
   • What it does: Allows main actions such as add, view, edit and delete to be performed without interfacing with the underlying data structure
   • Highlights: Added filter by amount, query and category methods, which allows method chaining and hence multiple filter conditions. Abstracted underlying data structure used to store entries to simplify CRUD operations
2. Implemented simplified REpresentational State Transfer (REST) architecture in OOP style
   • What it does: Decouples Frontend and Backend code by implementing Client-server model. Refactored code from v1.0 in #86.
   • Highlights: Authored /entry and /entries endpoint which simulates a REST API. Authored classes used for communications between Frontend and Backend (pocketpal.communication)
   • Credits: MDN - HTTP
3. Implemented main application logic in PocketPal, Frontend and Backend
4. Setup logging output to file (logs/pocketpal.txt)
5. Authored majority of test code for *Endpoint, Backend, Entry and EntryLog

Code Contributed: Reposense Link

Documentation

• User Guide
  • Frequently Asked Questions
• Developer Guide
  • Added design details, class and sequence diagrams illustrating how application works (Architecture, Frontend, Backend, API, Data Structure, Communication)
  • Added glossary definitions for less commonly used terms
  • Added navigation buttons in DG to allow easier manouevrability
  • Reformatted all PlantUML diagrams to follow required style (f7a2282)

Project Management

• Setup GitHub team organisation and repository
• Setup GitHub Pages for documentation
• Authored 42 issues, and maintained issue tracker
• Release management for v1.0, v2.0, v2.0.1, v2.1
• Reviewed pull requests (#26, #46, #47, #48, #57, #65, #155, #217, #227)
• Individual pull request comments can be viewed here

Community

• Reported module website bug (forum/#1)
• Response to downcasting (forum/#24)
• PR reviewed: #36

Tools

• Integrated third-party library (Gson) to the project (#86)

• Integrated Codecov to automate tracking of code coverage with GitHub Actions (#110, example)