-
Notifications
You must be signed in to change notification settings - Fork 231
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[CS2113-T15-2] BudgetBuddy #46
base: master
Are you sure you want to change the base?
Changes from 250 commits
c975653
3a9920e
693814f
1ae297e
e02c5fa
8af18f7
f298259
1c1b93e
17bae78
cc8570f
71c3c82
9f04522
6820232
3f8f544
70a1129
db104c8
a222239
886bcfb
1966121
d9b01e6
a466baa
961fbc9
17723d2
d537ee2
672065c
0fdcd11
3519839
5c88506
9d2994b
3407736
c371f00
078fbed
4d2fa61
2557351
3d82989
2217af4
86ef423
eaffaad
cf8289d
f485959
a63a23f
7911c51
62cbf18
7310ed8
92d6209
28bafe6
db4356e
fd96336
ef3c58f
e649c85
f0974ac
0f0042d
d7c5725
e1e4b93
d5bd47d
ab733ae
e80f195
a63260a
9b96e86
afcca05
70c05af
4c6cd7c
5249a66
f9c1ce4
c6267a5
0486506
938fc78
84718fc
e3d1a03
10bcf12
a3f3312
c1248ab
44ac6de
e724b0d
92664c6
6023ea2
ab7e09a
ac39076
ec4b238
b5bd383
70a0e08
8d4387d
2108f1e
a7cee9b
d7e562c
d3a5bc5
be08387
312d9c6
e32fd91
0bfdb47
199cd1b
7f19bc0
0e7c0d9
f5f070e
7e82956
eba4354
70a4cfe
1aad93e
ea50a58
30e6312
c62aba9
ac72d66
5da6d9c
4299149
95230bf
f1280fe
e84fa85
a9d1dd7
fb607ed
122523d
5be9d14
dcc2f9c
43b4335
2406ad3
ef65b79
15a57e2
bdaa92b
b2b387f
6a222f3
cc966f0
756af17
a180c5b
248f1a5
13617c2
f48d85a
b11ad9a
02c1781
7db0f38
562a919
18d5475
c1f0de4
b673593
017e5e6
1feda80
ae16ceb
cb7a464
7d6c4cc
b383e62
8dc4a36
f24228c
9cf42e4
a92d121
f1285d5
805592f
e635599
b9ec8ca
4fdcca6
739e3df
a09e1bf
a953341
12556db
f7ab114
203865b
b2804c3
4e53e01
164fa36
8721d4b
1302a31
1443058
f17de2f
e396231
5504724
e2bb3b1
9c04a41
34146e3
7015dad
4da12ba
e32d44f
2ea8daa
0ad93c2
371586d
3ccd4eb
7c232a9
87b3c77
4ad5af8
1e068cf
4063beb
70997ae
25d29f7
11e7c47
1adbcd7
827d799
e47b68a
600cfe9
895fc50
6089b2a
31f2e03
b3a9dc5
c2be51e
d12a134
c6ec752
29021ae
bc24868
a62357e
1f10b97
f934aa1
84210a7
bb43e40
f89d86f
11197d2
310c151
22258de
b9fa417
626d4a0
0f27aa1
c6d4bc8
74254db
221615f
12afb9f
fe78d59
e0284ad
e6d374d
f88360a
a27fd26
9d207cd
c7f8213
4d926b0
e9372d6
8442816
7a127dc
21e2740
5ae96e5
03ff83b
93cc596
b88f4a7
2b7d26e
047b1bd
82ff4b4
fc4eb75
a0c58f2
24ed3f9
d23d441
4464a5b
c3a43fa
1185c53
7565241
1cfe454
a5612f8
d29b8dd
88fc72c
0d3cbcf
da35b9f
6752a8e
ee09909
ecd34eb
f30fe73
47c856b
7b160d2
0b24e22
b8428a9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,3 +15,5 @@ bin/ | |
|
||
/text-ui-test/ACTUAL.TXT | ||
text-ui-test/EXPECTED-UNIX.TXT | ||
/data/accounts.txt | ||
/data/transactions.txt |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Very concise and well explained information shown in the Developer Guide |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Duke | ||
# BudgetBuddy | ||
|
||
{Give product intro here} | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,41 +2,125 @@ | |
|
||
## 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 mulitple accounts and even provides insights of your financial activites. | ||
|
||
## Quick Start | ||
1. Ensure that you have Java 11 or above installed. | ||
2. Down the latest version of `tp.jar` from [here](https://github.com/AY2324S2-CS2113-T15-2/tp/releases/tag/v1.0_release). | ||
3. Copy the file to the folder you want to use as the home folder for your BudgetBuddy. | ||
4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar ip.jar` command to run the application. | ||
5. Type the command in the command box and press Enter to execute it. e.g typing`list` and pressing Enter will prompt the help feature. | ||
## Features | ||
|
||
{Give steps to get started quickly} | ||
### Viewing help: `help` | ||
Shows the instructions for using BudgetBuddy. | ||
Format: `help` | ||
|
||
1. Ensure that you have Java 11 or above installed. | ||
1. Down the latest version of `Duke` from [here](http://link.to/duke). | ||
### 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). | ||
|
||
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` can be viewed using the command `list` followed by `1`. | ||
|
||
Example of usage: | ||
`delete 1` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The expected output can also be included for users to more clearly know what to expect when using the programme. |
||
|
||
### Edit a transaction: `edit` | ||
Edits the details of an existing transaction. | ||
Parameters: Transaction ID | ||
Format: `edit TRANSACTION_ID` | ||
* The `TRANSACTION_ID` can be viewed using the command `list` followed by `1`. | ||
|
||
Example of usage: | ||
`edit 2` | ||
|
||
### 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` | ||
|
||
## Features | ||
### 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`. | ||
|
||
{Give detailed description of each feature} | ||
Example of usage: | ||
`delete-acc 5431` | ||
|
||
### Adding a todo: `todo` | ||
Adds a new item to the list of todo items. | ||
### Edit an account: `edit-acc` | ||
Edits the details of an existing account. | ||
Parameters: Account Number | ||
Format: `edit-acc ACCOUNT_NUMBER` | ||
|
||
Format: `todo n/TODO_NAME d/DEADLINE` | ||
Example of usage: | ||
`edit-acc 5431` | ||
|
||
* The `DEADLINE` can be in a natural language format. | ||
* The `TODO_NAME` cannot contain punctuation. | ||
### View transaction insights: `insights` | ||
View transaction insights with the generated piecharts. | ||
Format: `insights` | ||
|
||
Example of usage: | ||
### Exiting the program: `bye` | ||
Exits BudgetBuddy. | ||
Format: `bye` | ||
|
||
`todo n/Write the rest of the User Guide d/next week` | ||
### Saving the data | ||
BudgetBuddy data are saved in the hard disk automatically when the user exits the program. There is no need to save the data manually. | ||
|
||
`todo n/Refactor the User Guide to remove passive voice d/13/04/2020` | ||
|
||
## 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` | ||
* 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` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# John Doe - Project Portfolio Page | ||
# Isaac Eng - Project Portfolio Page | ||
|
||
## Overview | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Jeevanandham Vavinan - Project Portfolio Page | ||
|
||
## Overview | ||
|
||
|
||
### Summary of Contributions |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Shyam Krishna Arun Gandhi - Project Portfolio Page | ||
|
||
## Overview | ||
|
||
|
||
### Summary of Contributions |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Vaibhav Dileep Pillai - Project Portfolio Page | ||
|
||
## Overview | ||
|
||
|
||
### Summary of Contributions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can be improved with the addition of diagrams to complement the content written