[CS2113-T15-2] BudgetBuddy

.github/workflows/gradle.yml

@@ -33,18 +33,18 @@ jobs:
       - name: Build and check with Gradle
         run: ./gradlew check
 
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat
+#      - name: Perform IO redirection test (*NIX)
+#        if: runner.os == 'Linux'
+#        working-directory:  ${{ github.workspace }}/text-ui-test
+#        run: ./runtest.sh
+#
+#      - name: Perform IO redirection test (MacOS)
+#        if: always() && runner.os == 'macOS'
+#        working-directory:  ${{ github.workspace }}/text-ui-test
+#        run: ./runtest.sh
+#
+#      - name: Perform IO redirection test (Windows)
+#        if: always() && runner.os == 'Windows'
+#        working-directory:  ${{ github.workspace }}/text-ui-test
+#        shell: cmd
+#        run: runtest.bat

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+/data/accounts.txt
+/data/transactions.txt

build.gradle

@@ -12,8 +12,10 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
+    implementation group: 'org.knowm.xchart', name: 'xchart', version: '3.2.2'
 }
 
+
 test {
     useJUnitPlatform()
 
@@ -29,11 +31,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("budgetbuddy.BudgetBuddy")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("budgetbuddy")
     archiveClassifier.set("")
 }
 
@@ -42,5 +44,6 @@ checkstyle {
 }
 
 run{
+//    enableAssertions = true
     standardInput = System.in
 }

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |           Name            |               Github Profile                | Portfolio 
+--------|:-------------------------:|:-------------------------------------------:|:---------:
+![](./team/images/vaibhav.png) | Vaibhav Dileep Pillai | [Github](https://github.com/vibes-863) | [Portfolio](./team/vaibhavDileepPillai.md)
+![](./team/images/Shyam.jpg) | Shyam Krishna Arun Gandhi | [Github](https://github.com/ShyamKrishna33) | [Portfolio](./team/shyamKrishna.md)
+![](./team/images/vavinan.jpg) | Jeevanandham Vavinan | [Github](https://github.com/Vavinan) | [Portfolio](./team/jeevanandhamVavinan.md)
+![](./team/images/isaac.jpg) | Isaac Eng | [Github](https://github.com/isaaceng7) | [Portfolio](./team/isaacEng.md)

docs/DeveloperGuide.md

@@ -8,6 +8,70 @@
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### [Implemented] Account feature
+#### Implementation
+The Account feature in the BudgetBuddy application serves as a core component for tracking the user's current financial 
+balance. This feature is primarily facilitated through the `Account` class, which encapsulates the balance attribute and
+provides mechanisms to get and set the balance. The Account object interacts closely with transactions, being updated 
+whenever transactions are added or deleted.
+
+Looking ahead, users will have the flexibility to manage multiple accounts—such as Wallet, Savings, Checking, and 
+Investment accounts—each encapsulated within the application's framework for seamless financial oversight. This 
+expansion will provide a comprehensive view of diverse financial sources and enhance personal financial management 
+within BudgetBuddy.
+
+
+### [Implemented] Category feature
+
+#### Description
+
+The Category feature empowers users to effectively categorize transactions based on their preferences. When initiating a
+new transaction through the `Add` command, users are prompted to select a category from a predefined list. This ensures
+organized and streamlined transaction management.
+
+#### Design and Implementation
+
+The implementation of the Category feature revolves around the integration of a `category` attribute within each
+transaction object. This attribute is defined as a member of the `Category` enum class.
+
+Upon invoking the `Add` command, users are presented with a selection prompt featuring the available categories. User
+input, typically in the form of a numerical identifier corresponding to a category within the enum class, facilitates
+the assignment of the appropriate enum object to the transaction's category attribute.
+
+
+### [Implemented] Remove transaction
+#### Description
+This method is used to remove a transaction from the list of transactions based on the transaction ID provided
+by the user. After the transaction is removed, the account balance is updated accordingly and a message is 
+displayed to the user indicating the success of the operation. This helps user to remove the transaction 
+from the list they added by mistake or those transactions they no longer need to keep track off.
+
+#### Parameters
+1. String input: A string containing the user input, which should include the transaction ID to be removed.
+2. Account account: The account object associated with the transaction list.
+
+#### Design and Implementation
+The method first validates the user input to ensure it's not empty or null. If the input is invalid, it throws
+an EmptyArgumentException. Next, it extracts the transaction ID from the input and verifies its integrity as a
+valid integer. If the ID is invalid, a NumberFormatException is thrown.
+
+Once a valid transaction ID is obtained, the method calculates its corresponding index in the transactions 
+ArrayList by subtracting 1 from the provided ID, as ArrayList indices start from 0 . It then verifies
+if the calculated index falls within the bounds of the ArrayList. If the index is out of bounds, an 
+InvalidIndexException is thrown.
+
+Upon successful validation, the method removes the transaction at the calculated index from the transactions
+ArrayList. Subsequently, it updates the account balance to reflect the removed transaction. Finally, it 
+notifies the user of the successful removal along with displaying the details of the removed transaction.
+
+### [Implemented] List feature
+#### Implementation
+The list feature in the BudgetBuddy application allows users to view all their past transactions. This feature is
+facilitated through the `UserInterface#printAllTransactions`, which loops through the entire ArrayList of transactions
+and extract all the details of each transaction.
+
+This feature will be further enhanced to include options to view transactions that the user is interested in only. For
+example, transactions of the past week, past month, specified date range.
 
 ## Product scope
 ### Target user profile

docs/README.md

@@ -1,4 +1,4 @@
-# Duke
+# BudgetBuddy
 
 {Give product intro here}
 

docs/UserGuide.md

@@ -2,41 +2,169 @@
 
 ## Introduction
 
-{Give a product intro}
+BudgetBuddy is a desktop app for managing personal finances, optimized for use via a Command Line Interface (CLI).
+It offers the tracking of income and expenses of multiple accounts and even provides insights of your financial
+activities.
 
 ## Quick Start
 
-{Give steps to get started quickly}
-
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Down the latest version of `tp.jar` from [here](https://github.com/AY2324S2-CS2113-T15-2/tp/releases/latest).
+3. Copy the file to the folder you want to use as the home folder for your BudgetBuddy app.
+4. Open a command terminal, `cd` into the folder you added the jar file to, and use the `java -jar tp.jar` command to
+   run the application.
+5. When prompted, type the command into the terminal and press Enter to execute it. e.g. typing `help` and pressing
+   Enter will prompt the help feature.
+
+## Features
+
+### Viewing help: `help`
+
+Shows the instructions for using BudgetBuddy.
+Format: `help`
+This command gives the list to search for commands, specific for each task. The commands `help all` and 
+`help acc` covers the basic structure of all commands. Instructions for command-specific help will be 
+provided in the `help all` and `help acc` accordingly.
+
+### Adding a transaction: `add`
+
+Adds a transaction into the transaction list of the specified account.
+Parameters: Account Number, Transaction Type, Name, Amount, Date, Category
+Format: `add /a/ACCOUNT_NUMBER /t/TRANSACTION_TYPE /n/NAME /$/AMOUNT /d/DATE /c/CATEGORY`
+
+* The `ACCOUNT_NUMBER` can be viewed using the command `list-acc`.
+* The `TRANSACTION_TYPE` includes **Expense** or **Income** ONLY.
+* The `AMOUNT` is in dollars ($).
+* The `DATE` should be in the format **DD-MM-YYYY**.
+* The `CATEGORY` is an integer. The categories are mapped to the following integers: 1 (Dining), 2 (Groceries), 3 (
+  Utilities), 4 (Transportation), 5 (Healthcare), 6 (Entertainment), 7 (Rent), 8 (Salary), 9 (Others).
+* NOTE: A transaction of a particular `CATEGORY` can be of both `TRANSACTION_TYPE`s.
+
+Example of usage:
+
+`add /a/5431 /t/Income /n/March Salary /$/10000 /d/01-03-2024 /c/8`
+
+`add /n/New iPhone /$/2000 /c/9 /t/Expense /a/5431 /d/20-03-2024`
+
+### View transaction history: `list`
+
+List the transactions. List options will include 1. All Transactions, 2. Past Week Transactions, 3. Past Month
+Transactions, 4. Custom Date Transactions.
+Format: `list`
+
+Example of usage:
+`list` followed by `1` to view All Transactions.
+`list` followed by `2` to view Past Week Transactions.
+`list` followed by `3` to view Past Week Transactions.
+`list` followed by `4` followed by the start date `01-01-2024` followed by the end date `31-03-2024` to view Custom Date
+Transactions from 01-01-2024 to 31-03-2024.
+
+### Deleting a transaction: `delete`
+
+Removes a transaction from transaction history.
+Parameters: Transaction ID
+Format: `delete TRANSACTION_ID`
+
+* The `TRANSACTION_ID` is an integer value ranges from one to the size of the transaction history (index
+  ID of the last transaction).
+* The `TRANSACTION_ID` can be viewed using the command `list` followed by `1`.
+
+Example of usage:
+`delete 1`
+
+### Edit a transaction: `edit`
+
+Edits the details of an existing transaction.
+Parameters: Transaction ID
+Format: `edit TRANSACTION_ID`
+
+* The `TRANSACTION_ID` is an integer value ranges from one to the size of the transaction history (index 
+  ID of the last transaction).
+* The `TRANSACTION_ID` can be viewed using the command `list` followed by `1`.
+* Edit transaction will only update the existing entry, so it won't change the index ID of that transaction. 
+  The edited transaction will still be accessible from the same index ID.
+
+Example of usage:
+`edit 2`
+
+Then the user will be asked to edit each information from that specific transaction one by one.
+
+### Add an account: `add-acc`
+
+Adds a new account with a specified initial balance.
+Parameters: Account Name, Initial Balance
+Format: `add-acc /n/ACCOUNT_NAME /$/INITIAL_BALANCE`
+
+* The `INITIAL_AMOUNT` is in dollars ($).
+
+Example of Usage:
+`add-acc /n/DBS Savings /$/10000`
+
+### List all accounts: `list-acc`
+
+List all the existing accounts.
+Format: `list-acc`
+
+### Delete an account: `delete-acc`
+
+Removes an account and removes all its transactions.
+Parameters: Account Number
+Format: `delete ACCOUNT_NUMBER`
+
+* The `ACCOUNT_NUMBER` can be viewed using the command `list-acc`.
+
+Example of usage:
+`delete-acc 5431`
+
+### Edit an account: `edit-acc`
+
+Edits the details of an existing account.
+Parameters: Account Number
+Format: `edit-acc ACCOUNT_NUMBER`
 
-## Features 
+Example of usage:
+`edit-acc 5431`
 
-{Give detailed description of each feature}
+### View transaction insights: `insights`
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+View the insights of all the transactions listed so far using a pie chart. Two pie charts are displayed,
+one for each type (i.e. `income` and `expense`). The pie charts show the percentage of total amount transferred
+in a particular category among all categories.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Format: `insights`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+### Exiting the program: `bye`
 
-Example of usage: 
+Exits BudgetBuddy.
+Format: `bye`
 
-`todo n/Write the rest of the User Guide d/next week`
+### Saving the data
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+BudgetBuddy data are saved in the hard disk automatically when the user exits the program. There is no need to save the
+data manually.
 
 ## FAQ
 
-**Q**: How do I transfer my data to another computer? 
+**Q**: How do I transfer my data to another Computer?
 
-**A**: {your answer here}
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains
+the data of your previous BudgetBuddy home folder.
 
 ## Command Summary
 
 {Give a 'cheat sheet' of commands here}
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* View help `help`
+* View help for all commands `help all`. Ths can be used to see all the commands related to transactions
+* View help for accounts `help acc`. This can be used to see all the commands related to account
+* Further help for each transaction command will be provided in the `help all`
+* Add transaction `add /a/ACCOUNT_NUMBER /t/TRANSACTION_TYPE /n/NAME /$/AMOUNT /d/DATE /c/CATEGORY`
+* List transactions `list`
+* Delete transaction `delete TRANSACTION_ID`
+* Edit transaction `edit TRANSACTION_ID`
+* Add account `add-acc /n/ACCOUNT_NAME /$/INITIAL_BALANCE`
+* List accounts `list-acc`
+* Delete account `delete-acc ACCOUNT_NUMBER`
+* Edit account `edit-acc ACCOUNT_NUMBER`
+* View insights `insights`
+* Exit program `bye`

docs/team/johndoe.md → docs/team/isaacEng.md

@@ -1,4 +1,4 @@
-# John Doe - Project Portfolio Page
+# Isaac Eng - Project Portfolio Page
 
 ## Overview
 

docs/team/jeevanandhamVavinan.md

@@ -0,0 +1,6 @@
+# Jeevanandham Vavinan - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions

docs/team/shyamKrishna.md

@@ -0,0 +1,6 @@
+# Shyam Krishna Arun Gandhi - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions

docs/team/vaibhavDileepPillai.md

@@ -0,0 +1,6 @@
+# Vaibhav Dileep Pillai - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions