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,5 @@
+/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
@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.planpal.PlanPal")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("PlanPal")
     archiveClassifier.set("")
 }
 
@@ -42,5 +42,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)
+Display |   Name   | Github Profile | Portfolio 
+--------|:--------:|:--------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) |  Gavin   | [Github](https://github.com/parasytezz) | [Portfolio](https://youtu.be/dQw4w9WgXcQ?si=G0x0I-NJflgQC8Ye)
+![](https://via.placeholder.com/100.png?text=Photo) | Bu Yin Shuang  | [Github](https://github.com/crystal-bys) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lam Hoi Kei | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Nathan  | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Si Thu Lin Aung  | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -1,30 +1,126 @@
 # Developer Guide
 
+---
+Welcome to the PlanPal Developer Guide! Thank you for taking an interest in the behind-the-scenes work of our product. We hope this document proves informative and useful for your work!
+
+## Table of Contents
+{to be inserted at a later date}
+
+---
+
 ## Acknowledgements
 
+
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+## Setting up, getting started
+1. Java 17 is required for PlanPal to function properly, please make sure your device has Java 17 installed. If not, you may download it [here](). If you need further assistance installing Java 17, you may refer to the [Installation Guide.]()
+2. Once you have ascertained that your device has Java 17 installed, you may download the `.jar file` [here]().
+insert SS of release page
+
+Click on `PlanPal.jar` to automatically download the file. Place the file in a folder your choice.
+
+
+
+## Design
+
+---
+### Architecture
+![Architecture.drawio.png](Images%2FArchitecture.drawio.png)
+
+The **Architecture Diagram** given above explains the high-level design of the program. Given below is a quick overview of the main components.
+
+### Main Components
+- `PlanPal`: Main entry of the program, initialises and connects the components
+- `UI`: In charge of printing messages
+- `Logic`: Determines the command to execute
+- `Storage`: Read and write data from hard disk
+- `Command`: Specific commands for execution
+
+### Program Flow
+- The `PlanPal` controls access to the `UI`, `Parser`, and `FileManager` (Storage) components of the app.
+- The user will send input to `PlanPal`.
+- `PlanPal` will parse the input to produce a `Command`, which will hook back into `PlanPal` to gain access to the other components when running
+
+---
+## Implementation
+---
+
+The class diagram below represents the contact book system
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+![ContactClassDiagram.jpg](Images/ContactClassDiagram.jpg)
 
+Currently, only the contact features have been illustrated.
+{to add other implementations for expense and activity managers}
 
+## Contact Manager Features
+
+### Add Command
+The sequence diagram below illustrates the process for resolving the "add" command.
+![AddContact.drawio.png](Images%2FAddContact.drawio.png)
+
+Explanation: 
+- Before this command is executed, the user will have to choose their mode.
+- When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
+- When command "add /name: john" is sent, the processCommand function is executed.
+- Since the command is "add", addContact function is executed using the description "/name: john". 
+- This creates a new contact and is then added to the list of contacts
+- Finally, contact file is saved in the savedContacts FileManager.
+
+### List Command
+The sequence diagram below illustrates the process for resolving the "list" command.
+
+![ViewContact.drawio.png](Images%2FViewContact.drawio.png)
+
+Explanation:
+- Before this command is executed, the user will have to choose their mode.
+- When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
+- When command "list" is sent, the processCommand function is executed.
+- Since the command is "add", viewContactList command is executed, printing all the contacts in the list.
+
+### Edit Command
+The sequence diagram below illustrates the process for resolving the "edit" command.
+![EditContact.drawio.png](Images%2FEditContact.drawio.png)
+
+### Set Category Command
+The sequence diagram below illustrates the process for resolving the "category" command.
+![SetCategory.drawio.png](Images%2FSetCategory.drawio.png)
+
+### Find Command
+The sequence diagram below illustrates the process for resolving the "find" command.
+
+![FindContact.jpg](Images/FindContact.jpg)
+
+## Expense Manager Features
+### Add Command
+
+For the expense manager, the add function works similar to the contact manager. The only difference being the names of the objects and the classes.
+
+---
 ## Product scope
 ### Target user profile
 
 {Describe the target user profile}
+As an international student in NUS, I want to be able to...
 
 ### Value proposition
 
 {Describe the value proposition: what problem does it solve?}
 
+---
+
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+|Version| As a ... | I want to ...             | So that I can ...                                                              |
+|--------|----------|---------------------------|--------------------------------------------------------------------------------|
+|v1.0|NUS international student| see my list of contacts   | easily call home or look for emergency contacts when needed                    |
+|v1.0|NUS international student| add a contact             | expand my list of useful contacts                                              |
+|v1.0|NUS international student| delete a contact          | remove a contact if I no longer need it                                        |
+|v1.0|NUS international student| edit a contact            | amend any mistakes when creating the contact or if the number has been changed |
+|v1.0|NUS international student| save my contacts          | my contacts are still there when I exit and enter the app again                |                                                       |
+|v2.0||  |                     |
 
+---
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
@@ -35,4 +131,4 @@
 
 ## Instructions for manual testing
 
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
diff --git a/docs/Images/AddContact.drawio.png b/docs/Images/AddContact.drawio.png
diff --git a/docs/Images/Architecture.drawio.png b/docs/Images/Architecture.drawio.png
diff --git a/docs/Images/ContactClassDiagram.jpg b/docs/Images/ContactClassDiagram.jpg
diff --git a/docs/Images/EditContact.drawio.png b/docs/Images/EditContact.drawio.png
diff --git a/docs/Images/FindContact.jpg b/docs/Images/FindContact.jpg
diff --git a/docs/Images/SetCategory.drawio.png b/docs/Images/SetCategory.drawio.png
diff --git a/docs/Images/ViewContact.drawio.png b/docs/Images/ViewContact.drawio.png
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -2,20 +2,77 @@
 
 ## Introduction
 
+---
 {Give a product intro}
 
-## Quick Start
 
-{Give steps to get started quickly}
+## Purpose of User Guide
 
-1. Ensure that you have Java 17 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+---
+The purpose of this guide is to show you how to get started on using this PlanPal and to introduce you to the basics of using it. this includes getting to know the feature and syntax of the commands.
+
+## Target Audience
 
-## Features 
+---
 
-{Give detailed description of each feature}
+## Quick Start
+
+---
+{Give steps to get started quickly}
 
-### Adding a todo: `todo`
+1. Ensure that you have Java 17 or above installed.
+2. Down the latest version of `PlanPal` from [here](http://link.to/duke).
+
+## Table of Contents
+- [Features](#Features)
+  - [Contacts](#1-Contacts)
+    - Add contact
+    - List contact
+    - Edit contact
+    - Delete contact
+    - Find contact
+  - Budget
+  - Activities
+    - Add activity
+    - List activity 
+    - Edit activity
+    - Delete activity
+    - Find activity
+---
+## Features
+This section will focus on some of the key features of PlanPal and explain their usage. We will go over several features, including the Contact functions, Budget functions, and Activity functions.
+
+1. [Contacts](#1-contacts)
+2. Budget
+3. Activities
+---
+## 1. Contacts
+PlanPal will assist you in tracking the Contacts in your planner, and is capable of adding new Contacts, removing Contacts, listing all Contacts, as well as editing Contacts. This guide will detail these features below.
+- Add contact
+- List contact
+- [Edit contact](#Editing-a-contact) 
+- Delete contact
+- Find contact
+---
+## Editing a Contact
+The `edit` command allows users to find a contact from the list
+
+### Usage:
+```
+edit <index> /<category 1>: <value 1> /<category 2>: <value 2> /<category 3>: <value 3> ... 
+```
+### Example 1:
+```
+edit 1 /name: Cassie
+```
+### Expected Output:
+```
+_________________________________________________________
+Edited successfully!
+_________________________________________________________
+```
+---
+### Adding a contact: `todo`
 Adds a new item to the list of todo items.
 
 Format: `todo n/TODO_NAME d/DEADLINE`

diff --git a/src/main/java/seedu/duke/Duke.java b/src/main/java/seedu/duke/Duke.java
diff --git a/src/main/java/seedu/planpal/PlanPal.java b/src/main/java/seedu/planpal/PlanPal.java
@@ -0,0 +1,31 @@
+package seedu.planpal;
+
+
+import seedu.planpal.exceptions.PlanPalExceptions;
+import seedu.planpal.utility.Ui;
+import seedu.planpal.utility.parser.Parser;
+
+import java.util.Scanner;
+
+
+public class PlanPal {
+    /**
+     * Main entry-point for the java.duke.Duke application.
+     */
+    public static void main(String[] args) {
+        Scanner in = new Scanner(System.in);
+        Ui.printWelcomeMessage();
+        Parser mainParser = new Parser();
+
+        while (true) {
+            try {
+                Ui.printAvailableModes();
+                String modeInput = in.nextLine();
+                mainParser.processCommand(modeInput);
+            } catch (PlanPalExceptions e) {
+                Ui.print(e.getMessage());
+            }
+        }
+
+    }
+}
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    /data/
     # IDEA files
     /.idea/
     /out/
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Manifest-Version: 1.0
		Main-Class: seedu.planpal.PlanPal