[Lim Yee Kian] iP

.gitignore

@@ -14,4 +14,5 @@ src/main/resources/docs/
 bin/
 
 /text-ui-test/ACTUAL.TXT
-text-ui-test/EXPECTED-UNIX.TXT
+/text-ui-test/EXPECTED-UNIX.TXT
+/data/Mel.txt

docs/README.md

@@ -1,30 +1,162 @@
-# Duke User Guide
+# Mel User Guide
 
-// Update the title above to match the actual product name
 
-// Product screenshot goes here
+![img.png](img.png)
 
-// Product intro goes here
+Mel is a console-based chatbot designed to help you manage tasks efficiently, including todos, deadlines, and events. The chatbot understands a variety of commands to add, remove, and track your tasks, as well as search and manage them interactively. With Mel, you can keep track of your schedule, deadlines, and daily tasks seamlessly.
 
-## Adding deadlines
+## Key Features:
 
-// Describe the action and its outcome.
+- Supports **todo** tasks for general items.
+- Adds **deadline** tasks with a specified date and optional time.
+- Manages **event** tasks with both start and end dates/times.
+- Allows marking/unmarking of task completion, and finding tasks by description. 
+- Keeps a running list of your tasks and saves them automatically.
 
-// Give examples of usage
+## Quick Start:
 
-Example: `keyword (optional arguments)`
+1. Ensure you have Java `17` or above installed in your Computer.
+2. Download the latest `.jar` file from [here](https://github.com/yeekian/ip/releases/tag/A-Release).
+3. Copy the file to the folder you want to use as the home folder for your Task Tracker.
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar Mel.jar` command to run the application.
 
-// A description of the expected outcome goes here
+Your command terminal similar to below should appear in a few seconds.
+<br>![img_1.png](img_1.png)
 
-```
-expected output
-```
+## List tasks: `list`
 
-## Feature ABC
+Displays the current list of tasks, showing their index, type, description, and whether they are completed or not.
 
-// Feature details
+Format: `list`
 
+## Adding a todo task: `todo`
 
-## Feature XYZ
+Adds tasks without any date/time attached to it e.g., explore the new garden
 
-// Feature details
+Format: `todo DESCRIPTION`
+- Adds the todo task with the specified DESCRIPTION. The DESCRIPTION refers to the name of the task that will be shown in the task list. 
+- The DESCRIPTION is a string and must not be empty.
+
+Examples:
+
+    todo read book
+
+
+## Adding a deadline task: `deadline`
+
+Adds tasks that need to be done before a specific date/time e.g., return book by 04/11/2024 8pm
+
+Format: `deadline DESCRIPTION /by DATE`
+- Adds the deadline task with the specified `DESCRIPTION`. The `DESCRIPTION` refers to the name of the task that will be shown in the task list.
+- The `DESCRIPTION` is a string and must not be empty.
+- Adds deadline date and/or time to the task with the specified `DATE`. The `DATE` is input as a string and must not be empty.
+- The `DATE` has to be specified in one of the following formats:
+  - yyyy-MM-dd HH:mm 
+  - yyyy-MM-dd 
+  - dd/MM/yyyy HH:mm 
+  - dd/MM/yyyy 
+- Adding deadline time to `DATE` is optional, if not given, it will be automatically filled with 23:59
+
+
+Examples:
+
+    //Add a deadline task with a description and deadline of return book and Nov 04 2024, 08:00 pm, respectively
+    deadline return book /by 2024-11-04 20:00 
+
+    //Add a deadline task with a description and deadline of submit quiz and Nov 05 2024, 11:59 pm, respectively
+    deadline submit quiz /by 2024-11-05
+
+    //Add a deadline task with a description and deadline of return book and Nov 07 2024, 09:00 pm, respectively
+    deadline order cake /by 07/11/2024 21:00 
+
+    //Add a deadline task with a description and deadline of submit form and Nov 09 2024, 11:59 pm, respectively
+    deadline submit form /by 09/11/2024 
+
+## Adding a event task: `event`
+
+Adds tasks that start at a specific date/time and ends at a specific date/time e.g., team project meeting on 2/10/2019 from 2pm to 4pm
+
+Format: `event DESCRIPTION /from START_TIME /to END_TIME`
+- Adds the event task with the specified `DESCRIPTION`. The `DESCRIPTION` refers to the name of the task that will be shown in the task list.
+- The `DESCRIPTION` is a string and must not be empty.
+- Adds event start and end date/time to the task with the specified `START_TIME` and `END_TIME`, respectively. The `START_TIME` and `END_TIME` are input as strings and must not be empty.
+- The `START_TIME` and `END_TIME` can be specified as a string in any format.
+
+
+Examples:
+
+    //Add an event task with a description, start time and end time of dinner with friends, 5pm and 6pm, respectively
+    event dinner with friends /from 5pm /to 6pm 
+
+## Deleting a task: `delete`
+
+Deletes the specified task from the task list.
+
+Format: `delete INDEX`
+- Deletes the task at the specified `INDEX`.
+- The index refers to the index number shown in the displayed task list. 
+- The index **must be a positive integer** 1, 2, 3, ...
+
+Examples:
+
+    //Delete the 2nd task in the task list
+    delete 2 
+
+## Mark/Unmark Task Completion: `mark`/ `unmark`
+
+Marks/unmarks the specified task from the task list.
+
+Format: `mark INDEX`/ `unmark INDEX`
+- Marks/unmarks the task at the specified `INDEX` to completed/uncompleted.
+- The index refers to the index number shown in the displayed task list.
+- The index **must be a positive integer** 1, 2, 3, ...
+
+Examples:
+
+    //Mark the 2nd task in the task list as completed
+    mark 2 
+
+    //Unmark the 2nd task in the task list so that is becomes uncompleted
+    unmark 2 
+
+## Finding tasks by description keywords: `find`
+
+Finds persons whose names contain any of the given keywords.
+
+Format: `find KEYWORD_STRING`
+- The search is case-insensitive. e.g. book will match Book
+- The entire keyword string must be found within the task description. e.g. read a large book will not match with read a small book
+- Parts of words will be matched e.g. Pen will match Pencil
+- Only the task description is searched.
+
+Examples:
+
+    //Return submit quiz and submit form
+    find submit 
+
+    //Return read magazine, book reservation
+    find read book 
+
+## End Chatbot: `bye`
+
+Exits the program.
+
+Format: `bye`
+
+## Saving the data
+
+The task list data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+
+## Command Summary
+
+| Action                         | Format, Examples                                                                                                                        |
+|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| **List tasks**                 | `list`                                                                                                                                  |
+| **Add a todo task**            | `todo DESCRIPTION` <br/>e.g., `todo read book`                                                                                          |
+| **Add a deadline task**        | `deadline DESCRIPTION /by DATE` <br/>e.g., `deadline return book /by 2024-11-04 20:00` <br/>e.g., `deadline submit form /by 2024-11-05` |
+| **Add an event task**          | `event DESCRIPTION /from START_TIME /to END_TIME` <br/>e.g., `event dinner with friends /from 5pm /to 6pm`                              |
+| **Delete a task**              | `delete INDEX` <br/>e.g., `delete 2`                                                                                                    |
+| **Mark task as completed**     | `mark INDEX` <br/>e.g., `mark 2`                                                                                                        |
+| **Unmark task as uncompleted** | `unmark INDEX` <br/>e.g., `unmark 2`                                                                                                    |
+| **Find tasks**                 | `find KEYWORD_STRING` <br/>e.g., `find read book`                                                                                       |
+| **End the chatbot**            | `bye`                                                                                                                                   |

src/main/java/Mel.java

@@ -0,0 +1,44 @@
+import main.TaskList;
+import main.Parser;
+import main.Storage;
+import main.Ui;
+
+import java.util.Scanner;
+import java.io.IOException;
+import java.io.File;
+
+public class Mel {
+
+    private static final String LIST_FILE_PATH = "data" + File.separator + "Mel.txt"; // Use File.separator for cross-platform compatibility
+
+    private Storage storage;
+    private TaskList userList;
+    private Ui ui;
+    private Scanner in;
+
+    public Mel(String filePath) {
+        ui = new Ui();
+        storage = new Storage(filePath);
+
+        // Set up scanner for user input
+        in = new Scanner(System.in);
+        userList = new TaskList(ui);
+    }
+
+    public void run() {
+        ui.printIntroMessage();
+
+        try {
+            storage.writerSetUp();
+            storage.loadDataFromFile(userList); // Load saved tasks
+        } catch (IOException e) {
+            System.out.println("An error occurred when setting up writer.");
+        }
+
+        Parser.getUserInput(in, storage, ui, userList);
+    }
+
+    public static void main(String[] args) throws IOException {
+        new Mel(LIST_FILE_PATH).run();
+    }
+}

src/main/java/exception/EmptyDateFieldException.java

@@ -0,0 +1,5 @@
+package exception;
+
+public class EmptyDateFieldException extends RuntimeException {
+    //no other code needed
+}

src/main/java/exception/EmptyDescriptionException.java

@@ -0,0 +1,5 @@
+package exception;
+
+public class EmptyDescriptionException extends Exception {
+    //no other code needed
+}