[Li Xinyi] iP

README.md

@@ -1,24 +1,126 @@
-# Duke project template
+# Duke project: the task management chatbot
+## project user guide
 
-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.
+* This is a CLI(command line interface) task management application named Baymax.
+* 
 
 ## Setting up in Intellij
 
 Prerequisites: JDK 11, update Intellij to the most recent version.
 
 1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
+2. Open the project into Intellij as follows:
    1. Click `Open`.
-   1. Select the project directory, and click `OK`.
-   1. If there are any further prompts, accept the defaults.
-1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
+   2. Select the project directory, and click `OK`.
+   3. If there are any further prompts, accept the defaults.
+3. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
    In the same dialog, set the **Project language level** field to the `SDK default` option.
-3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+4. After that, locate the `src/main/java/Baymax.java` file, right-click it, and choose `Run Baymax.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
+
+```
+Hello, I'm Baymax.
+Your personal task managing companion. 
+What can I do for you? 
+```
+
+5. The application now should run in the console.
+6. Now you can interact with the program in the console.
+
+
+*Using Command Line*
+
+1. 'Build' the project using IntelliJ.
+2. Open the `Terminal`/`Command Prompt`.
+3. `cd` into the project's `out\production\ip` directory
+4. Type `java Baymax`, then press enter to execute.
+5. Now you can interact with the program through the CLI.. 
+
+
+## Features
+### three types of tasks
+### 1. Feature-event:
+- event is a subclass of task, with description and date.
+### 2. Feature-deadline:
+- deadline is a subclass of task, with description and due date.
+### 3. Feature-todo:
+- todo is a subclass of task, with description of the task.
+
+## Usage
+1. Adding a todo task
+   * Add a todo task to the list of tasks.
+   * Format: `todo <description>`
+   * Words inside `< >` are parameters. There is no need to type the `<` and `>`.
+   * Example of usage:`todo Read textbook`
+   * Expected oucome:
+```
+Got it. I've added this task:
+[T][ ] Read textbook
+Now you have 1 tasks tasks in the list.
+```
+
+2. Adding a deadline task
+   * Add a deadline task to the list of tasks.
+   * Format: `deadline <task> /by <MM dd yyyy>`
+   * Example:
+      * `deadline Submit lab report /by 03 04 2022`
+   * Expected oucome:
+```
+Got it. I've added this task:
+[D][ ] Submit lab report /by 03 04 2022`
+Now you have 2 tasks tasks in the list.
+```
+3. Adding a event task
+   * Add an event task to the list of tasks.
+   * Format: `event <task> /at <MM dd yyyy>`
+   * Example:
+      * `event Attend meeting /at 03 04 2022`
+   * Expected oucome:
+```
+Got it. I've added this task:
+[E][ ] Submit lab report /by 03 04 2022`
+Now you have 3 tasks tasks in the list.
+```
+
+4. Listing all tasks: `list`
+   * Display the entire list of tasks.
+   * Format: `list`
+   * Expected oucome:
+
+```
+Here are the tasks in your list:
+1.[T][ ] Read textbook
+2.[D][ ] Submit lab report /by 03 04 2022
+3.[E][ ] Submit lab report /by 03 04 2022`
+```
+5. Finding all tasks containing a keyword in their description: `find`
+   * Find all the tasks whose description contains the specified keyword.
+   * Format: `find <keyword>`
+   * Example:
+      * `find meeting` +
+        Returns all tasks containing `meeting` in description.
+
+6. Deleting a task: `delete`
+   * Delete a task by specifying the index of it.
+   * Format: `delete <index>`
+   * Example:
+      * `delete 2` +
+        Deletes the second task in the task list.
+
+7. Marking a task: `mark`
+   * Mark a task as done by specifying the index of it.
+   * Format: `mark <index>`
+   * Example:
+      * `mark 3` +
+        Marks the third task in the task list as done.
+
+8. Marking a task: `unmark`
+   * Unmark a task as not done yet by specifying the index of it.
+   * Format: `unmark <index>`
+   * Example:
+      * `mark 1` +
+        Unmark the first task in the task list.
+
+9. Exiting the program: `bye`
+   * Exit the program.
+   * Format: `bye`
+   * Expected output:`Bye, Hope to see you again soon!`

data/Baymax.txt

@@ -0,0 +1,4 @@
+D / 0 / xinyi submit cs2113 ip  / 03 02 2022
+E / 1 / xinyi learns lecture  / 03 29 2022
+T / 0 / xinyi practice coding / 
+T / 0 / Mark release a jar file / 

docs/README.md

@@ -1,29 +1,126 @@
-# User Guide
+# Duke project: the task management chatbot
+## project user guide
 
-## Features 
+* This is a CLI(command line interface) task management application named Baymax.
+*
 
-### Feature-ABC
+## Setting up in Intellij
 
-Description of the feature.
+Prerequisites: JDK 11, update Intellij to the most recent version.
 
-### Feature-XYZ
+1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
+2. Open the project into Intellij as follows:
+    1. Click `Open`.
+    2. Select the project directory, and click `OK`.
+    3. If there are any further prompts, accept the defaults.
+3. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
+   In the same dialog, set the **Project language level** field to the `SDK default` option.
+4. After that, locate the `src/main/java/Baymax.java` file, right-click it, and choose `Run Baymax.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
 
-Description of the feature.
+```
+Hello, I'm Baymax.
+Your personal task managing companion. 
+What can I do for you? 
+```
+
+5. The application now should run in the console.
+6. Now you can interact with the program in the console.
 
-## Usage
 
-### `Keyword` - Describe action
+*Using Command Line*
 
-Describe the action and its outcome.
+1. 'Build' the project using IntelliJ.
+2. Open the `Terminal`/`Command Prompt`.
+3. `cd` into the project's `out\production\ip` directory
+4. Type `java Baymax`, then press enter to execute.
+5. Now you can interact with the program through the CLI..
 
-Example of usage: 
 
-`keyword (optional arguments)`
+## Features
+### three types of tasks
+### 1. Feature-event:
+- event is a subclass of task, with description and date.
+### 2. Feature-deadline:
+- deadline is a subclass of task, with description and due date.
+### 3. Feature-todo:
+- todo is a subclass of task, with description of the task.
+
+## Usage
+1. Adding a todo task
+    * Add a todo task to the list of tasks.
+    * Format: `todo <description>`
+    * Words inside `< >` are parameters. There is no need to type the `<` and `>`.
+    * Example of usage:`todo Read textbook`
+    * Expected oucome:
+```
+Got it. I've added this task:
+[T][ ] Read textbook
+Now you have 1 tasks tasks in the list.
+```
 
-Expected outcome:
+2. Adding a deadline task
+    * Add a deadline task to the list of tasks.
+    * Format: `deadline <task> /by <MM dd yyyy>`
+    * Example:
+        * `deadline Submit lab report /by 03 04 2022`
+    * Expected oucome:
+```
+Got it. I've added this task:
+[D][ ] Submit lab report (by: 03 04 2022)
+Now you have 2 tasks tasks in the list.
+```
+3. Adding a event task
+    * Add an event task to the list of tasks.
+    * Format: `event <task> /at <MM dd yyyy>`
+    * Example:
+        * `event Attend meeting /at 03 04 2022`
+    * Expected oucome:
+```
+Got it. I've added this task:
+[E][ ] Submit lab report (by: 03 04 2022)
+Now you have 3 tasks tasks in the list.
+```
 
-Description of the outcome.
+4. Listing all tasks: `list`
+    * Display the entire list of tasks.
+    * Format: `list`
+    * Expected oucome:
 
 ```
-expected output
+Here are the tasks in your list:
+1 [T][ ] Read textbook
+2 [D][ ] Submit lab report (by: 03 04 2022)
+3 [E][ ] Submit lab report (at: 03 04 2022)
 ```
+5. Finding all tasks containing a keyword in their description: `find`
+    * Find all the tasks whose description contains the specified keyword.
+    * Format: `find <keyword>`
+    * Example:
+        * `find meeting` +
+          Returns all tasks containing `meeting` in description.
+
+6. Deleting a task: `delete`
+    * Delete a task by specifying the index of it.
+    * Format: `delete <index>`
+    * Example:
+        * `delete 2` +
+          Deletes the second task in the task list.
+
+7. Marking a task: `mark`
+    * Mark a task as done by specifying the index of it.
+    * Format: `mark <index>`
+    * Example:
+        * `mark 3` +
+          Marks the third task in the task list as done.
+
+8. Marking a task: `unmark`
+    * Unmark a task as not done yet by specifying the index of it.
+    * Format: `unmark <index>`
+    * Example:
+        * `mark 1` +
+          Unmark the first task in the task list.
+
+9. Exiting the program: `bye`
+    * Exit the program.
+    * Format: `bye`
+    * Expected output:`Bye, Hope to see you again soon!`

src/main/java/Baymax.java

@@ -0,0 +1,58 @@
+import java.lang.String;
+
+import java.io.IOException;
+
+import baymax.data.TaskManager;
+import baymax.ui.Ui;
+import baymax.parse.Parser;
+import baymax.storage.Storage;
+
+/**
+ * Enter point for Baymax task management bot
+ * Initialize the task manager
+ */
+public class Baymax {
+
+    /**
+     * initialize UI, taskmanager, and storage.
+     * @param filePath the txt file location where
+     *                 the application read from and store in
+     */
+    private final Ui ui;
+    private TaskManager tManager;
+
+    public Baymax(String filePath) {
+        ui = new Ui();
+        Storage storage = new Storage(filePath);
+        try {
+            tManager = new TaskManager(storage.load());
+        } catch (IOException e) {
+            ui.showLoadingError(e.getMessage());
+            tManager = new TaskManager();
+        }
+    }
+
+    /**
+     * Read user input
+     * keep iteration until exit signal is sent
+     * @throws IOException
+     */
+    public void run() throws IOException {
+        ui.displayWelcomeMessage();
+        boolean isBye;
+        isBye = false;
+        while (!isBye) {
+            String fullCommand = ui.getUserCommand();
+            Parser parse = new Parser(ui);
+            parse.parse(fullCommand, tManager);
+            isBye = parse.getExit();
+        }
+        ui.showByeMessage();
+    }
+
+    public static void main(String[] args) throws IOException {
+        new Baymax("data/Baymax.txt").run();
+    }
+}
+
+

src/main/java/BaymaxException.java

@@ -0,0 +1,5 @@
+public class BaymaxException extends RuntimeException{
+    public BaymaxException(String errorMessage){
+        super(errorMessage);
+    }
+}

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

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