[CS2113-W10-1] BudgetBuddy

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+/logs/

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.budgetbuddy.BudgetBuddy
+

README.md

@@ -1,28 +1,25 @@
-# Duke project template
+# BudgetBuddy
 
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
+BudgetBuddy is a Command Line Interface (CLI) desktop application designed to help users manage their finances efficiently.
+With BudgetBuddy, users can categorize expenses and income, add and deduct budgets, visualize income and expenses
+through graphs, manage savings, and store data persistently. Given below are instructions on how to use it.
 
 ## Setting up in Intellij
 
 Prerequisites: JDK 17 (use the exact version), update Intellij to the most recent version.
 
 1. **Ensure Intellij JDK 17 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 17 in a previous Intellij project.
 1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the setup**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+1. **Verify the setup**: After the importing is complete, locate the `src/main/java/seedu/budgetbuddy/BudgetBuddy.java` file, right-click it, and choose `Run BudgetBuddy.main()`. If the setup is correct, you should see something like the below:
    ```
    > Task :compileJava
    > Task :processResources NO-SOURCE
    > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
+
+   > Task :seedu.budgetbuddy.BudgetBuddy.main()
+   ========================================================
+   Welcome to Budget Buddy!
+   ========================================================
    ```
    Type some word and press enter to let the execution proceed to the end.
 
@@ -39,7 +36,7 @@ Prerequisites: JDK 17 (use the exact version), update Intellij to the most recen
 
 ### JUnit tests
 
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
+* A skeleton JUnit test (`src/test/java/seedu/budgetbuddy/BudgetBuddyTest.java`) is provided with this project template.
 * If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
 
 ## Checkstyle
@@ -55,7 +52,7 @@ The project uses [GitHub actions](https://github.com/features/actions) for CI. W
 
 `/docs` folder contains a skeleton version of the project documentation.
 
-Steps for publishing documentation to the public: 
+Steps for publishing documentation to the public:
 1. If you are using this project template for an individual project, go your fork on GitHub.<br>
    If you are using this project template for a team project, go to the team fork on GitHub.
 1. Click on the `settings` tab.

build.gradle

@@ -12,10 +12,12 @@ 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 'org.knowm.xchart:xchart:3.8.8'
 }
 
 test {
     useJUnitPlatform()
+    jvmArgs '-ea'
 
     testLogging {
         events "passed", "skipped", "failed"
@@ -29,11 +31,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.budgetbuddy.BudgetBuddy")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("budgetbuddy")
     archiveClassifier.set("")
 }
 
@@ -43,4 +45,6 @@ checkstyle {
 
 run{
     standardInput = System.in
+    jvmArgs '-ea'
+    enableAssertions = true
 }

data/BudgetBuddy.txt

@@ -0,0 +1,30 @@
+expense | plane | 1000.0 | 15/9/2024 | FOOD
+expense | hello | 2.0 | 15/9/2024 | OTHERS
+expense | go skiing | 100.0 | 15/10/2024 | FOOD
+expense | plane tickets to korea | 1000.0 | 15/9/2024 | OTHERS
+expense | zoo tickets | 20.0 | 15/9/2024 | FOOD
+expense | plane tickets to japan | 1000.0 | 15/10/2024 | OTHERS
+expense | plane tickets to europe | 1000.0 | 1/8/2024 | OTHERS
+expense | wingstop | 20.0 | 15/10/2024 | OTHERS
+expense | plane ticket to japan | 1000.0 | 10/10/2024 | TRANSPORT
+expense | food | 5.5 | 10/10/2024 | FOOD
+expense | test | 10.0 | 10/10/2024 | OTHERS
+expense | popmart | 300.0 | 20/10/2023 | ENTERTAINMENT
+expense | table | 123.0 | 1/10/2023 | OTHERS
+expense | char | 2567.0 | 3/10/2023 | OTHERS
+expense | fly kite | 50.0 | 9/10/2025 | ENTERTAINMENT
+expense | go zoo | 300.0 | 10/10/2024 | OTHERS
+expense | restaurant | 300.0 | 10/10/2025 | FOOD
+income | tuition fees | 1000.0 | 15/9/2024
+income | tuition | 2.0E8 | 15/9/2024
+income | tuition fee | 10000.0 | 15/10/2024
+income | Starbucks crew | 1000.0 | 1/10/2024
+income | Mcdonald crew | 1000.0 | 15/10/2024
+income | fries crew | 2000.0 | 15/10/2023
+income | tuition fee | 1000.0 | 15/9/2024
+budget | 3200.0 | 2024-11 | {ENTERTAINMENT=3000.0, FOOD=200.0}
+budget | 2400.0 | 2024-10 | {TRANSPORT=1200.0, ENTERTAINMENT=1200.0}
+budget | 2550.0 | 2024-08 | {OTHERS=1800.0, FOOD=750.0}
+budget | 1700.0 | 2024-07 | {OTHERS=1700.0}
+budget | 3900.0 | 2024-05 | {OTHERS=1300.0, ENTERTAINMENT=1300.0, FOOD=1300.0}
+budget | 2600.0 | 2023-08 | {OTHERS=1900.0, UTILITIES=700.0}

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # 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                         |
+|--------------------------------------|--------------|-------------------------------------------|-----------------------------------|
+| ![](images/Portrait_placeholder.png) | Kenneth Ang  | [Github](https://github.com/Chinorea)     | [Portfolio](team/chinorea.md)     |
+| ![](images/Portrait_placeholder.png) | Telfer Ang   | [GitHub](https://github.com/telferang)    | [Portfolio](team/telferang.md)    |
+| ![](images/Portrait_placeholder.png) | Cleon        | [GitHub](https://github.com/chuacleon)    | [Portfolio](team/chuacleon.md)    |
+| ![](images/Portrait_placeholder.png) | Zilia Ang    | [Github](https://github.com/ZiliaAJY)     | [Portfolio](team/ziliaajy.md)     |
+| ![](images/Portrait_placeholder.png) | Alfred Goh   | [Github](https://github.com/Alfred-Goh02) | [Portfolio](team/alfred-goh02.md) |