User Guide

Welcome to Nus Expenses Tracker(NET). NET is an app for managing expenses, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).

Quick Start

1. Ensure you have Java 11 or above installed in your Computer.
2. Download the latest NusExpensesTracker.jar from here.
3. Copy the file to the directory you want to use as the home directory for your Nus Expenses Tracker Application.
4. Open a command prompt / terminal window in that directory.
5. Run the command java -jar [TIC4001-4][NUSExpensesTracker].jar to open up the application.
6. Type the help in the command box and press Enter to execute it.

Features

Help: Lists the commands the user can use to interact with the application.
Add: Add Transactions with optional date/time or category.
Update: Update a transaction’s attributes, description, amount or category.
Total: Display the sum total spent from all transactions.
Delete: Delete transactions a specified transaction.
View: View transactions that have been added.
Search: Find transactions using a specified keyword.
Add Budget: Add a Budget with optional date/time.
View Budget: View all budgets that have been added.
Generate Report: Export data into an Excel file (.xlsx) containing a summary of transactions with an optional specified time period.
Exit: Exit NUSExpenses Tracker

Help

Format: help
Example: help
Output:
—————————————————
add: Adds a transaction to the NUS Expenses Tracker.
Parameters: DESCRIPTION $AMOUNT DATE
Example: add Lunch at Com2 $4.50 14-Oct-2020
—————————————————

Add

Format: add
Example: add lime juice $1.80 10 Oct 2020
Output:
---------------------------------------------------
New transaction added
---------------------------------------------------

Update

Format: update /d (optional)/u (optional)/c (optional)/a
Example: update 1 /u dinner /d 2020-09-24 /a $5.0 /c FOOD
Output:
---------------------------------------------------
Transaction updated
---------------------------------------------------

Total

Format: total
Example: total
Output:

1. Date: lunch Description: 3.5 Amount:
   
2. Date: lime juice Description: 1.8 Amount:
   
3. Date: dinner Description: 5.6 Amount:
   —————————————————
   The total amount you have spent so far is $10.90
   —————————————————
   

Delete

Format: delete {index number} - The index must be a positive integer 1, 2, 3,(…)
Example: delete 1
Output:
—————————————————
Transaction deleted.
—————————————————

View

Format 1: view {category}
Format 2: view /sd {date} /ed {date}
Format 3: view /sd {date}
Format 4: view /ed {date}

Example 1: view MISC
Output:
Description: lunch Amount: $3.0 Category: MISC
Description: dinner Amount: $4.0 Date: 2020-09-09 Category: MISC
—————————————————
Displaying Category: MISC
Above are all transaction entered
—————————————————

Example 2: view /sd 2020-09-08 /ed 2020-09-10
Output:
Description: dinner Amount: $4.0 Date: 2020-09-09 Category: MISC
—————————————————
Displaying : 2020-09-08 - 2020-09-10
Above are all transaction entered
—————————————————

Example 3: view /sd 2020-09-08
Output:
Description: dinner Amount: $4.0 Date: 2020-09-09 Category: MISC
—————————————————
Displaying : Every transaction after - 2020-09-08
Above are all transaction entered
—————————————————

Example 4: view /ed 2020-09-10
Output:
Description: dinner Amount: $4.0 Date: 2020-09-09 Category: MISC
—————————————————
Displaying : Every transaction before - 2020-09-10
Above are all transaction entered
—————————————————

Search

Format: search {keyword}
Example: search dinner
Output:

1. Description: dinner Amount: $4.0 Date: 2020-09-09 Category: MISC
   
2. Description: dinner Amount: $5.0 Date: 2020-09-24 Category: FOOD
   
   —————————————————
   2 transactions listed.
   —————————————————
   

Add Budget

Format: budgetadd {category} {/description} {amount}
Example: budgetadd daily /FOOD $20.00
Output:
—————————————————
New Budget has been added.
—————————————————

View Budget

Format: budgetview
Example: budgetview
Output:
CATEGORY: DAILY || DESCRIPTION: FOOD || Budget : $50.0
Current Spending TODAY for CATEGORY FOOD is $5.0
You expenses is on track. Good Job!
—————————————————
Above are all budgets entered.
—————————————————

Generate Report

Format: report /sd (optional) /ed (optional)
Example 1: report /sd 2020-09-28 /ed 2020-09-30
Example 2: report
Output:
---------------------------------------------------
Report exported successfully.
---------------------------------------------------

Saving the data

Saving of the data is done automatically after each command. It will be saved into the expenses/mytransactions.txt is the directory where you can find the list of transactions saved.

Support or Contact

Having trouble with executing the program? Contact the team here and We’ll help you sort it out.