[Jiale Sun] iP

docs/README.md

@@ -1,29 +1,81 @@
 # User Guide
 
-## Features 
+Duke is a CLI task-managing app to help you and make your life easier.
 
-### Feature-ABC
+##Quick Start
+1. Ensure you have Java 11 or above installed in your computer.
+2. Download the latest Duke JAR file from github.
+3. Locate the JAR file into a folder which you will run it from.
+4. Navigate to this folder using CLI and run the command `java -jar ip.jar`
+5. You can now start using Duke by typing the features command directly!
 
-Description of the feature.
+## Features
 
-### Feature-XYZ
+### Showing all tasks: `list`
 
-Description of the feature.
+Shows all tasks in the task list.
 
-## Usage
+* Format: `list`
 
-### `Keyword` - Describe action
+### Finding a task: `find`
 
-Describe the action and its outcome.
+Finds a task in the task list.
 
-Example of usage: 
+* Format: `find TASK`
+* Example: `find study`
 
-`keyword (optional arguments)`
+### Marking a task as done: `done`
 
-Expected outcome:
+Marks the task as done.
 
-Description of the outcome.
+* Format: `done TASK_INDEX`
+* TASK_INDEX is a positive number which refer to the task.
+* Example: `done 1`
 
-```
-expected output
-```
+### Deleting a task: `delete`
+
+Deletes a task from the task list.
+
+* Format: `delete TASK_INDEX`
+* TASK_INDEX is a positive number which refer to the task.
+* Example: `delete 1`
+
+### Recording a deadline task: `deadline`
+
+Adds a deadline task into the task list.
+
+* Format: `deadline TASK_NAME /by TASK_TIME`
+* Example: `deadline sleep /by 11p.m.`
+
+### Recording a event task: `event`
+
+Adds a event task into the task list.
+
+* Format: `event TASK_NAME /at TASK_TIME`
+* Example: `event eat /at 11a.m.`
+
+### Recording a todo task: `todo`
+
+Adds a todo task into the task list.
+
+* Format: `todo TASK_NAME`
+* Example: `todo study`
+
+### Exiting the program: `bye`
+
+Exits the program.
+
+* Format: `bye`
+
+## Command Summary
+
+Action | Format & Example
+-------|-----------------
+Show all tasks|`list`
+Find a task|`find TASK` (eg. `find work`)
+Mark a task as done|`done TASK_INDEX` (eg. `done 1`)
+Delete a task|`delete TASK_INDEX` (eg. `delete 1`)
+Record a deadline task| `deadline deadline TASK_NAME /by TASK_TIME` (eg. `deadline sleep /by 11p.m.`)
+Record a event task|`event TASK_NAME /at TASK_TIME` (eg. `event eat /at 11a.m.`)
+Record a todo task| `todo TASK_NAME` (eg. `todo study`)
+Exit the program|`bye`

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect

src/main/java/META-INF/MANIFEST.MF

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

src/main/java/duke/Duke.java

@@ -0,0 +1,22 @@
+package duke;
+
+import java.util.Scanner;
+
+/**
+ * Shows the main class of Duke.
+ */
+public class Duke {
+
+    public static void main(String[] args) {
+        UI.printWelcomeMessage();
+        String lineInput;
+        Storage.getFromFile();
+        do {
+            Scanner input = new Scanner(System.in);
+            lineInput = input.nextLine();
+            Parser.parseInput(lineInput);
+            UI.printBreaker();
+        } while (!lineInput.equals("bye"));
+        UI.printByeMessage();
+    }
+}

src/main/java/duke/DukeExceptions.java

@@ -0,0 +1,8 @@
+package duke;
+
+public class DukeExceptions extends Exception{
+
+    public DukeExceptions(String errorMessage) {
+        super(errorMessage);
+    }
+}

src/main/java/duke/Parser.java

@@ -0,0 +1,50 @@
+package duke;
+
+import duke.task.*;
+
+/**
+ * Formats the inputs to pass to different methods.
+ */
+public class Parser {
+
+    /**
+     * Formats the input sent from the user and pass it to different methods accordingly.
+     *
+     * @param lineInput The line input from the user.
+     */
+    public static void parseInput(String lineInput)  {
+        boolean printMessage = true;
+        String[] arrayInput = lineInput.split(" ");
+        String userCommand = arrayInput[0];
+        try {
+            switch (userCommand) {
+            case "list":
+                TaskList.showTask();
+                break;
+            case "done":
+                int doneIndex = Integer.parseInt(arrayInput[1]);
+                TaskList.doneTask(doneIndex, printMessage);
+                break;
+            case "find":
+                TaskList.searchTask(arrayInput);
+                break;
+            case "event":
+            case "todo":
+            case "deadline":
+                TaskList.recordTask(userCommand, lineInput, printMessage);
+                break;
+            case "delete":
+                String deleteIndex = arrayInput[1];
+                TaskList.deleteTask(deleteIndex);
+                break;
+            case "bye":
+                break;
+            default:
+                System.out.println("OOPS!!! Sorry, but I do not understand:(");
+                break;
+            }
+        } catch (ArrayIndexOutOfBoundsException | NumberFormatException | StringIndexOutOfBoundsException e) {
+            System.out.println("OOPS!!! Please enter a valid input:(");
+        }
+    }
+}

src/main/java/duke/Storage.java

@@ -0,0 +1,71 @@
+package duke;
+
+import java.util.Scanner;
+
+import java.io.IOException;
+
+import java.io.File;
+import java.io.FileWriter;
+
+import java.util.ArrayList;
+
+import duke.task.*;
+
+/**
+ * Reads from a text file and writes to the file to store tasks.
+ */
+public class Storage {
+
+    /**
+     * Gets the task list from the file.
+     */
+    public static void getFromFile() {
+        try {
+            File file = new File("src/main/java/duke/data/task.txt");
+            file.createNewFile();
+            Scanner updateInput = new Scanner(file);
+            boolean printMessage = false;
+            int taskNumber = 1;
+            while (updateInput.hasNext()) {
+                String[] arrayInput = updateInput.nextLine().split("\\|");
+                switch (arrayInput[0]) {
+                case "D ":
+                    TaskList.recordTask("deadline", "deadline" + arrayInput[2], printMessage);
+                    break;
+                case "E ":
+                    TaskList.recordTask("event", "event" + arrayInput[2], printMessage);
+                    break;
+                case "T ":
+                    TaskList.recordTask("todo", "todo" + arrayInput[2], printMessage);
+                    break;
+                }
+                if (arrayInput[1].equals(" 1 ")) {
+                    TaskList.doneTask(taskNumber, printMessage);
+                }
+                taskNumber++;
+            }
+        } catch (IOException e) {
+            System.out.println("There is no saved file:( but I will create a new one for you:)");
+        }
+    }
+
+    /**
+     * Saves the task list to the file.
+     *
+     * @param listInput The task list to be saved.
+     * @param taskNumber The integer total number of tasks in the list.
+     */
+    public static void saveToFile(ArrayList<Task> listInput, int taskNumber) {
+        try {
+            FileWriter file = new FileWriter("src/main/java/duke/data/task.txt");
+            for (int i = 0; i < taskNumber; i++) {
+                String numberStatus = ((listInput.get(i).getTaskStatus().equals("[X] "))? "1" : "0");
+                String stringToSave = listInput.get(i).getTaskType() + " | " + numberStatus +  " | " + listInput.get(i).getTaskDescription() + "\n";
+                file.write(stringToSave);
+            }
+            file.close();
+        } catch (IOException e) {
+            System.out.println("There is no valid file:(");
+        }
+    }
+}