[Liu Ze Hui] iP

docs/README.md

@@ -1,29 +1,198 @@
-# User Guide
+# YOJ User Guide
 
-## Features 
 
-### Feature-ABC
+## Overview
+YOJ is a CLI-based application that allows users to track their tasks. Users can
+add and delete tasks from a list, mark them as Done or undone and view all current tasks. This user guide aims to
+help users get familiarized with the different commands available in the application.
 
-Description of the feature.
 
-### Feature-XYZ
+## Quick Start 
+1. Download Java11.
+2. Download the latest JAR file from [here](https://github.com/liuzehui03/ip/releases/tag/A-Release).
+3. Move the JAR file into an empty folder.
+4. In the command terminal, use the `cd` command to switch to the
+   folder with the JAR file.
+5. Enter `java -jar ip.jar` in the command terminal to run this application.
+6. Refer to the features below for details of the various commands and how to use YOJ.
 
-Description of the feature.
 
-## Usage
+## Features
 
-### `Keyword` - Describe action
 
-Describe the action and its outcome.
+### Viewing all tasks: `list`
 
-Example of usage: 
+Shows a list of all the current tasks, along with their
+descriptions and status.
 
-`keyword (optional arguments)`
 
-Expected outcome:
+Format: `list`
 
-Description of the outcome.
+Example of usage:
 
 ```
-expected output
+list
 ```
+
+Expected output:
+```
+AGENDA ✉
+♡ All the best!! 💕 
+_____________
+1. [T][ ] add tasks
+2. [D][ ] finish user guide (by: monday)
+3. [E][X] project meeting (from: Mon 2pm to: 4pm)
+```
+
+### Adding a ToDo task: `todo`
+
+Adds a ToDo task to the task list.
+
+Format: `todo [description]`
+
+Example of usage:
+
+```
+todo exercise
+```
+
+Expected output:
+```
+okii task added :
+[T][ ] exercise
+Now you have 1 tasks in the list
+```
+
+### Adding a Deadline task: `deadline`
+
+Adds a Deadline task to the task list.
+
+Format: `deadline [description] /by [deadline]`
+
+Example of usage:
+
+```
+deadline return file /by monday
+```
+
+Expected output:
+```
+okii task added :
+[D][ ] return file (by: monday)
+Now you have 2 tasks in the list.
+```
+
+### Adding an Event task: `event`
+
+Adds an Event task to the task list.
+
+Format: `event [description] /from [eventStart] /to [eventEnd]`
+
+Example of usage:
+
+```
+event project meeting /from Mon 2pm /to 4pm
+```
+
+Expected output:
+```
+okii task added :
+[E][ ] project meeting (from: Mon 2pm to: 4pm)
+Now you have 3 tasks in the list.
+```
+
+### Marking a task as done: `mark`
+
+Changes the status of the selected task to Done.
+
+Format: `mark [index]`
+
+Example of usage:
+
+```
+mark 1
+```
+
+Expected output:
+```
+okiee! amazing!! I've marked this task as done: 
+[T][X] exercise
+```
+
+### Marking a task as undone: `unmark`
+
+Changes the status of the selected task to Undone.
+
+Format: `unmark [index]`
+
+Example of usage:
+
+```
+unmark 1
+```
+
+Expected output:
+```
+alright I've marked this task as not done yet, do rmb to do it soon: 
+[T][ ] exercise
+```
+
+
+### Removing a task: `delete`
+
+Removes a specific task from the task list.
+
+Format: `delete [index]`
+
+Example of usage:
+
+```
+delete 1
+```
+Expected output:
+```
+okiee i've deleted the task
+[T][ ] exercise
+Now you have 2 tasks in the list.
+```
+
+### Finding a task: `find`
+
+Returns all tasks in the task list that contains the keyword.
+
+Format: `find [keyword]`
+
+Example of usage:
+
+```
+find assignment
+```
+
+Expected output:
+```
+🔍 here are the tasks found with the keyword!
+1. [T][ ] assignment 3
+2. [T][ ] review assignment 2
+```
+
+### Exiting the program: `bye`
+
+Exits the application and saves all tasks in a file.
+
+Format: `bye`
+
+Example of usage:
+
+```
+bye
+```
+
+
+Expected output:
+```
+bye bye!! hope to see u soon :) 😊
+```
+Make sure to say bye to ensure your data is saved properly, otherwise YOJ might not remember the tasks
+
+### Data Management
+Data would be saved locally on your device upon usage of `bye`

src/META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: Yoj.Yoj
+

src/main/data/Yojdata.txt

@@ -0,0 +1,2 @@
+[T] | 0 | haha
+[D] | 0 | bfwgr

src/main/java/Yoj/Yoj.java

@@ -0,0 +1,45 @@
+package Yoj;
+
+import Yoj.exception.InvalidCommandException;
+import Yoj.exception.YojException;
+import Yoj.parser.Parser;
+import Yoj.storage.Storage;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.util.Scanner;
+import Yoj.taskList.List;
+import Yoj.ui.*;
+
+
+public class Yoj {
+    /**
+     * main method is the entry point for Yoj which handles user input and commands processing for the task management system.
+     *
+     * @param args Command-line arguments passed to the application.
+     * @throws YojException Custom exception for application-specific errors.
+     * @throws InvalidCommandException Custom exception for invalid commands entered by the user.
+     * @throws FileNotFoundException Exception thrown when the file with saved tasks is not found.
+     *
+     */
+    public static void main(String[] args) throws YojException, InvalidCommandException, FileNotFoundException {
+        Ui.printHello();
+        // get user input
+        Scanner in = new Scanner(System.in);
+        List.tasks = Storage.loadTasks();
+        String userInput;
+        do {
+            userInput = in.nextLine();
+            try {
+                Parser.manageUserInput(userInput);
+            } catch (YojException e){
+                System.out.println(e.getMessage());
+            } catch (InvalidCommandException e) {
+                System.out.println(e.getMessage());
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
+        } while (!userInput.equals("bye"));
+        in.close();
+
+    }
+}

src/main/java/Yoj/exception/InvalidCommandException.java

@@ -0,0 +1,6 @@
+package Yoj.exception;
+public class InvalidCommandException extends Exception{
+    public InvalidCommandException(String message){
+        super(message);
+    }
+}

src/main/java/Yoj/exception/YojException.java

@@ -0,0 +1,6 @@
+package Yoj.exception;
+public class YojException extends Exception {
+    public YojException(String message) {
+        super(message);
+    }
+ }

src/main/java/Yoj/parser/Parser.java

@@ -0,0 +1,48 @@
+package Yoj.parser;
+
+import Yoj.taskList.List;
+import Yoj.exception.InvalidCommandException;
+import Yoj.exception.YojException;
+import Yoj.storage.Storage;
+import Yoj.ui.Ui;
+import java.io.IOException;
+import static Yoj.taskList.List.tasks;
+
+/**
+ * This class is responsible for parsing the user input and managing the corresponding actions.
+ */
+public class Parser {
+    /**
+     * Parses the user input and invokes the appropriate action based on the command.
+     *
+     * @param userInput The full line of input entered by the user.
+     * @throws YojException If there's a problem specific to Yoj's functionality.
+     * @throws InvalidCommandException If the entered command is not recognized.
+     * @throws IOException If there is an input/output error during task handling.
+     */
+    public static void manageUserInput(String userInput) throws YojException, InvalidCommandException, IOException {
+        if (userInput.equals("list")) {
+            Ui.printList();
+        } else if(userInput.matches("mark \\d+")) {
+            String[] taskIndex = userInput.split(" ");
+            int index = Integer.parseInt(taskIndex[1] );
+            tasks.get(index - 1).markDone();
+            Ui.markDoneMessage(index);
+        } else if(userInput.matches("unmark \\d+")) {
+            String[] taskIndex = userInput.split(" ");
+            int index = Integer.parseInt(taskIndex[1]);
+            tasks.get(index - 1).markUndone();
+            Ui.markUndoneMessage(index);
+        } else if(userInput.startsWith("todo") || userInput.startsWith("deadline") || userInput.startsWith("event")) {
+            List.addTask(userInput);
+        } else if(userInput.startsWith("delete")) {
+            List.deleteTask(userInput);
+        } else if(userInput.startsWith("find")) {
+            String description = userInput.substring("find ".length()).trim();
+            List.findTask(description);
+        } else if(userInput.equals("bye")){
+            Ui.byeMessage();
+            Storage.save(tasks);
+        } else throw new InvalidCommandException("unfortunately im not sure what u mean... :<");
+    }
+}