nus-cs2113-AY2425S1 · C2linaung · Nov 4, 2024 · Nov 4, 2024 · Nov 4, 2024 · Nov 4, 2024
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+.env
+/data/
+/backup_data/
+
 # IDEA files
 /.idea/
 /out/

diff --git a/META-INF/MANIFEST.MF b/META-INF/MANIFEST.MF
@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.planpal.PlanPal
+
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Duke project template
+# PlanPal
 
 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.
 

diff --git a/build.gradle b/build.gradle
@@ -12,6 +12,9 @@ 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'
+
+    // https://mvnrepository.com/artifact/net.lingala.zip4j/zip4j
+    implementation group: 'net.lingala.zip4j', name: 'zip4j', version: '2.11.5'
 }
 
 test {
@@ -29,11 +32,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.planpal.PlanPal")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("PlanPal")
     archiveClassifier.set("")
 }
 
@@ -42,5 +45,7 @@ checkstyle {
 }
 
 run{
+    enableAssertions = true
     standardInput = System.in
 }
+
diff --git a/docs/AboutUs.md b/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)
+|      Name       |              Github Profile              |                                                      Portfolio                                                       |
+|:---------------:|:----------------------------------------:|:--------------------------------------------------------------------------------------------------------------------:|
+|      Gavin      | [Github](https://github.com/parasytezz)  |                     [Portfolio](https://ay2425s1-cs2113-w14-2.github.io/tp/team/parasytezz.html)                     |
+|  Bu Yin Shuang  | [Github](https://github.com/crystal-bys) |                    [Portfolio](https://ay2425s1-cs2113-w14-2.github.io/tp/team/crystal-bys.html)                     |
+|   Lam Hoi Kei   |   [Github](https://github.com/anlamm)    |                       [Portfolio](https://ay2425s1-cs2113-w14-2.github.io/tp/team/anlamm.html)                       |
+|   Nathan Tan    |   [Github](https://github.com/Yisoong)   |                      [Portfolio](https://ay2425s1-cs2113-w14-2.github.io/tp/team/yisoong.html)                       |
+| Si Thu Lin Aung |  [Github](https://github.com/C2linaung)  |                     [Portfolio](https://ay2425s1-cs2113-w14-2.github.io/tp/team/c2linaung.html)                      |
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/Images(DG)/ActivityClassDiagram.drawio.png b/docs/Images(DG)/ActivityClassDiagram.drawio.png
diff --git a/docs/Images(DG)/AddActivties.drawio.png b/docs/Images(DG)/AddActivties.drawio.png
diff --git a/docs/Images(DG)/AddContact.drawio.png b/docs/Images(DG)/AddContact.drawio.png
diff --git a/docs/Images(DG)/AddExpense.drawio.png b/docs/Images(DG)/AddExpense.drawio.png
diff --git a/docs/Images(DG)/AddExpenseRef1.drawio.png b/docs/Images(DG)/AddExpenseRef1.drawio.png
diff --git a/docs/Images(DG)/AddExpenseRef2.drawio.png b/docs/Images(DG)/AddExpenseRef2.drawio.png
diff --git a/docs/Images(DG)/Architecture.drawio.png b/docs/Images(DG)/Architecture.drawio.png
diff --git a/docs/Images(DG)/ContactClassDiagram.drawio.png b/docs/Images(DG)/ContactClassDiagram.drawio.png
diff --git a/docs/Images(DG)/DeleteActivties.drawio.png b/docs/Images(DG)/DeleteActivties.drawio.png
diff --git a/docs/Images(DG)/DeleteContact.drawio.png b/docs/Images(DG)/DeleteContact.drawio.png
diff --git a/docs/Images(DG)/DeleteExpense.drawio.png b/docs/Images(DG)/DeleteExpense.drawio.png
diff --git a/docs/Images(DG)/EditActivity.drawio.png b/docs/Images(DG)/EditActivity.drawio.png
diff --git a/docs/Images(DG)/EditContact.drawio.png b/docs/Images(DG)/EditContact.drawio.png
diff --git a/docs/Images(DG)/EditExpense.drawio.png b/docs/Images(DG)/EditExpense.drawio.png
diff --git a/docs/Images(DG)/ExpenseClassDiagram.png b/docs/Images(DG)/ExpenseClassDiagram.png
diff --git a/docs/Images(DG)/FindActivity.drawio.png b/docs/Images(DG)/FindActivity.drawio.png
diff --git a/docs/Images(DG)/FindContactDiagram.drawio.png b/docs/Images(DG)/FindContactDiagram.drawio.png
diff --git a/docs/Images(DG)/FindExpensesDiagram.drawio.png b/docs/Images(DG)/FindExpensesDiagram.drawio.png
diff --git a/docs/Images(DG)/MainProgramFlowDiagram.drawio.png b/docs/Images(DG)/MainProgramFlowDiagram.drawio.png
diff --git a/docs/Images(DG)/ParserClassDiagram.drawio.png b/docs/Images(DG)/ParserClassDiagram.drawio.png
diff --git a/docs/Images(DG)/SearchByCategory.drawio.png b/docs/Images(DG)/SearchByCategory.drawio.png
diff --git a/docs/Images(DG)/SetBudgetDiagram.drawio.png b/docs/Images(DG)/SetBudgetDiagram.drawio.png
diff --git a/docs/Images(DG)/SetContactCategory.drawio.png b/docs/Images(DG)/SetContactCategory.drawio.png
diff --git a/docs/Images(DG)/ViewActivity.drawio.png b/docs/Images(DG)/ViewActivity.drawio.png
diff --git a/docs/Images(DG)/ViewContact.drawio.png b/docs/Images(DG)/ViewContact.drawio.png
diff --git a/docs/Images(DG)/ViewExpensesDiagram.drawio.png b/docs/Images(DG)/ViewExpensesDiagram.drawio.png
diff --git a/docs/Images(UG)/AddingEmail.png b/docs/Images(UG)/AddingEmail.png
diff --git a/docs/Images(UG)/AddingPhone.png b/docs/Images(UG)/AddingPhone.png
diff --git a/docs/Images(UG)/Help.png b/docs/Images(UG)/Help.png
diff --git a/docs/Images(UG)/INVALID COMMAND.png b/docs/Images(UG)/INVALID COMMAND.png
diff --git a/docs/Images(UG)/InvalidInput.png b/docs/Images(UG)/InvalidInput.png
diff --git a/docs/Images(UG)/InvalidInput2.png b/docs/Images(UG)/InvalidInput2.png
diff --git a/docs/Images(UG)/MainScreen.png b/docs/Images(UG)/MainScreen.png
diff --git a/docs/Images(UG)/MissingSlash.png b/docs/Images(UG)/MissingSlash.png
diff --git a/docs/Images(UG)/ModeScreen.png b/docs/Images(UG)/ModeScreen.png
diff --git a/docs/Images(UG)/RepeatedCategory.png b/docs/Images(UG)/RepeatedCategory.png
diff --git a/docs/Images/PlanPal Preview.png b/docs/Images/PlanPal Preview.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,8 +1,17 @@
-# Duke
+# PlanPal
 
-{Give product intro here}
+--- 
 
-Useful links:
-* [User Guide](UserGuide.md)
-* [Developer Guide](DeveloperGuide.md)
-* [About Us](AboutUs.md)
+![PlanPal Preview.png](Images/PlanPal%20Preview.png)
+
+**PlanPal** is a desktop application designed for international students at NUS, providing a comprehensive solution for managing contacts, tracking expenses, and organizing activities.
+The application is developed in Java 17 and most user interactions take place using a Command Line Interface (CLI).
+It helps users manage their finances, stay connected with key contacts, and efficiently plan activities while studying abroad, ensuring that students can effortlessly stay organized and on top of all their responsibilities.
+
+- If you are interested in using PlanPal, the [User Guide](UserGuide.md) will help you get started.
+- If you are interested about the development of PlanPal, the [Developer Guide](DeveloperGuide.md) will contain the relevant information.
+
+### Useful Documents
+- [User Guide](UserGuide.md)
+- [Developer Guide](DeveloperGuide.md)
+- [About Us](AboutUs.md)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Manifest-Version: 1.0
		Main-Class: seedu.planpal.PlanPal