[John Nicholas S] iP

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Duke
 
 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.
 
@@ -17,7 +17,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    ```
    Hello from
     ____        _        
-   |  _ \ _   _| | _____ 
+   |  _ \ _   _| | _____
    | | | | | | | |/ / _ \
    | |_| | |_| |   <  __/
    |____/ \__,_|_|\_\___|

data/brave.txt

@@ -0,0 +1,5 @@
+T , 1 , read book
+D , 1 , return book , June 6th
+E , 0 , project meeting , Aug 6th 2-4pm
+T , 1 , join sports club
+T , 0 , cs2113 lecture

docs/README.md

@@ -1,29 +1,217 @@
 # User Guide
 
+Brave is a **Command Line Interface (CLI) application** for you to manage your daily task
+Todo - Event - Deadline
+
+- [Quick Start](#quick-start)
+- [Features](#features)
+    - [Adding a Todo: `todo`](#adding-a-todo-todo)
+    - [Adding a Deadline: `deadline`](#adding-a-deadline-deadline)
+    - [Adding an Event: `event`](#adding-an-event-event)
+    - [Listing all tasks: `list`](#listing-out-all-tasks-list)
+    - [Marking a task as done: `mark`](#marking-a-task-as-completed-mark)
+    - [Marking a task as incomplete : `unmark`](#marking-a-task-as-incomplete-unmark)
+    - [Deleting a task: `delete`](#deleting-a-task-delete)
+    - [Searching for tasks: `find`](#searching-for-tasks-find)
+    - [Exiting the program: `bye`](#exiting-the-program-bye)
+
+## Quick Start
+1. Prerequisites: JDK 11, update Intellij to the most recent version.
+2. Download the latest copy of `ip.jar` from the [Releases](https://github.com/johnsuharjono/ip/releases) page.
+3. Open your Command Prompt (Windows) or Terminal (Mac/Linux), and navigate to the folder you created.
+4. Run the command `java -jar ip.jar`, this will be shown in your terminal if successfull
+    ```
+    -*|Brave|*------------------------------------
+    Greetings from
+      ____                        _ 
+     | __ ) _ __ __ ___   _____  | |
+     |  _ \| '__/ _` \ \ / / _ \ | |
+     | |_) | | | (_| |\ V /  __/ |_|
+     |____/|_|  \__,_| \_/ \___| (_)
+
+    What can I do for you?
+    ----------------------------------------------
+    ```
+
 ## Features 
 
-### Feature-ABC
+### Adding a Todo: `todo`
+
+Create a To-Do type task
+
+**Format:** `todo <description>`
+
+**Example Input:**
+```
+todo learn web development
+```
+
+**Example Output:**
+```
+-*|Brave|*------------------------------------
+Okay! I have added task below!
+[T][ ] learn web development
+You currently have 6 task in the list
+----------------------------------------------
+```
+
+### Adding a Deadline: `deadline`
+
+Create a Deadline type task
+
+**Format:** `deadline <description> /by <time>`
+
+**Example Input:**
+```
+deadline finish math homework /by Thursday Morning
+```
+
+**Example Output:**
+```
+-*|Brave|*------------------------------------
+Okay! I have added task below!
+[D][ ] finish math homework (by: Thursday Morning)
+You currently have 8 task in the list
+----------------------------------------------
+```
+
+### Adding an Event: `event`
+
+Add an Event type task
+
+**Format:** `event <description> /at <time>`
+
+**Example Input:**
+```
+event Brave's birthday /at 4 March 2022
+```
+
+**Example Output:**
+```
+-*|Brave|*------------------------------------
+Okay! I have added task below!
+[E][ ] Brave's birthday (at: 4 March 2022)
+You currently have 7 task in the list
+----------------------------------------------
+```
+
+### Listing out all tasks: `list`
+
+Shows all currently stored task by Brave
+
+**Format:** `list`
+
+**Example Output:**
+```
+-*|Brave|*------------------------------------
+1 [T][X] read book
+2 [D][X] return book (by: June 6th)
+3 [E][ ] project meeting (at: Aug 6th 2-4pm)
+4 [T][X] join sports club
+5 [T][ ] cs2113 lecture
+6 [T][ ] learn web development
+7 [E][ ] Brave's birthday (at: 4 March 2022)
+8 [D][ ] finish math homework (by: Thursday Morning)
+----------------------------------------------
+```
+
+### Marking a task as completed: `mark`
+
+Brave will mark the given task as completed
+
+**Format:** `mark <index>`
+
+> **️ Note:** index can be seen from calling `list` command
+
+
+**Example Input:**
+```
+mark 3
+```
+
+**Example Output:**
+```
+-*|Brave|*------------------------------------
+Nice! I've marked this task as done:
+[E][X] project meeting (at: Aug 6th 2-4pm)
+----------------------------------------------
+```
 
-Description of the feature.
+### Marking a task as incomplete: `unmark`
 
-### Feature-XYZ
+Brave will mark the given task as incomplete
 
-Description of the feature.
+**Format:** `unmark <index>`
 
-## Usage
+> **️ Note:** index can be seen from calling `list` command
 
-### `Keyword` - Describe action
 
-Describe the action and its outcome.
+**Example Input:**
+```
+unmark 3
+```
 
-Example of usage: 
+**Example Output:**
+```
+-*|Brave|*------------------------------------
+OK, I've marked this task as not done yet:
+[E][ ] project meeting (at: Aug 6th 2-4pm)
+----------------------------------------------
+```
+
+### Deleting a task: `delete`
 
-`keyword (optional arguments)`
+Remove a task stored by Brave.
 
-Expected outcome:
+**Format:** `delete <index>`
 
-Description of the outcome.
+> **Note:**  
+> `<index>` can be referenced from the `list` command.
 
+**Example Input:**
 ```
-expected output
+delete 6
+```
+
+**Example Output:**
 ```
+-*|Brave|*------------------------------------
+I managed to delete task below!
+[T][ ] learn web development
+You now have 7 task remaining
+----------------------------------------------
+```
+
+### Searching for tasks: `find`
+
+Filter the task base on `<keyword>`
+
+**Format:** `find <keyword>`
+
+**Example Input:**
+```
+find book
+```
+
+**Example Output:**
+```
+find book
+-*|Brave|*------------------------------------
+1 [T][X] read book
+2 [D][X] return book (by: June 6th)
+----------------------------------------------
+```
+
+### Exiting the program: `bye`
+
+Quits the program.
+
+**Format:** `bye`
+
+**Output:**
+```
+-*|Brave|*------------------------------------
+Bye, Hope to see you again soon!
+----------------------------------------------
+```
+

docs/_config.yml

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

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

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

src/main/java/brave/Brave.java

@@ -0,0 +1,61 @@
+package brave;
+
+import brave.data.TaskManager;
+import brave.parser.Parser;
+import brave.ui.Ui;
+import brave.storage.Storage;
+
+import java.io.IOException;
+import java.lang.String;
+import java.nio.file.Path;
+
+
+/**
+ * Represent the entry point for Brave-Bot Task Helper
+ * Initialize the UI, TaskManager, and Storage component.
+ */
+public class Brave {
+
+    private final Ui ui;
+    private TaskManager tasks;
+    private final Storage storage;
+
+    /**
+     * Initialize the UI, loading the file data from storage
+     *
+     * @param filePath filepath for the program to read from
+     */
+    public Brave(String filePath) {
+        ui = new Ui();
+        storage = new Storage(filePath);
+        try {
+            tasks = new TaskManager(storage.load());
+        } catch (IOException e) {
+            ui.showLoadingError(e.getMessage());
+            tasks = new TaskManager();
+        }
+    }
+
+    /**
+     * Read the user input command,
+     * Keep iterating until stop condition is reached
+     */
+    public void run() {
+        ui.showWelcomeMessage();
+        boolean isExit = false;
+
+        while (!isExit) {
+            String fullCommand = ui.getUserCommand();
+            Parser p = new Parser(ui, storage);
+            p.parse(fullCommand, tasks);
+            isExit = p.getExit();
+        }
+
+        ui.showFarewellMessage();
+    }
+
+    public static void main(String[] args) {
+        String DIR_PATH = String.valueOf(Path.of(System.getProperty("user.dir"), "data"));
+        new Brave(DIR_PATH + "/brave.txt").run();
+    }
+}

src/main/java/brave/IllegalArgumentException.java

@@ -0,0 +1,4 @@
+package brave;
+
+public class IllegalArgumentException extends Exception{
+}

src/main/java/brave/data/Deadline.java

@@ -0,0 +1,40 @@
+package brave.data;
+
+/**
+ * Inherit from Task class, with additional "by" as the deadline
+ */
+public class Deadline extends Task {
+    private String by;
+
+    /**
+     * Class constructor
+     * @param description description for the given task
+     * @param by indicating the deadline of given task
+     */
+    public Deadline(String description, String by) {
+        super(description);
+        this.by = by;
+    }
+
+    public String getDescription() {
+        return super.getDescription() + String.format(" (by: %s)", this.by);
+    }
+
+    /**
+     * Override print method
+     * @return String that is correctly formatted
+     */
+    @Override
+    public String toString() {
+        return "[D]" + super.toString();
+    }
+
+    @Override
+    public String getSaveFormat() {
+        if (!isDone) {
+            return "D , 0 , " + this.description + " , " + this.by;
+        } else {
+            return "D , 1 , " + this.description + " , " + this.by;
+        }
+    }
+}