[Chua Zhong Heng] iP

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+/data/
+text-ui-test/data/KenergeticBot.txt

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# KenergeticBot project template
 
 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.
 
@@ -13,12 +13,10 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
    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>
    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:
+3. After that, locate the `src/main/java/KenergeticBot.java` file, right-click it, and choose `Run KenergeticBot.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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
+    ____________________________________________________________
+     Hello! I'm KenergeticBot
+     What can I do for you?
+    ____________________________________________________________
    ```

docs/README.md

@@ -1,29 +1,136 @@
 # User Guide
+## Hi there! I am KenergeticBot
+I am a personal Task managing chatbot, able to store tasks such as To dos, Deadlines and Events.
+
+## 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:
+   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>
+   In the same dialog, set the **Project language level** field to the `SDK default` option.
+3. After that, locate the `src/main/java/KenergeticBot.java` file, right-click it, and choose `Run KenergeticBot.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 KenergeticBot
+        What can I do for you?
+       ____________________________________________________________
+
 
 ## Features 
 
-### Feature-ABC
+> **Notes about command format:**
+> - Words encased in `{ }` are the arguments to be supplied by user. <br>
+    e.g. `deadline {Description} /by {Deadline Date & Time}`, `Description` and `Deadline Date & Time` are arguments to be specified by user.
+> - Parameters need to be in the exact format as specified. <br>
+    e.g. `event {Description} /from {Event Start Date & Time} /to {Event End Date & Time}`, `/from` must come before `/to`.
+### Here are some of the things I can do!
+
+### Task Creation
+
+Create 3 types of Tasks:
+
+1. Todo: Tasks which are not time sensitive.
+
+    Format: `todo {Description}`
+
+    Example: <br> `todo read book`
+2. Deadline: Tasks which are time sensitive, able to indicate deadline using /by.
+
+   Format: `deadline {Description} /by {Deadline Date & Time}`
+
+   Example: <br> `deadline return book /by Sunday`
+3. Event: Tasks which are happening at a specific time frame, using /from and /to.
+
+   Format: `event {Description} /from {Event Start Date & Time} /to {Event End Date & Time}`
+
+   Example: <br> `event project meeting /from Mon 2pm /to 4pm`
+
+
+### Task Viewing
+
+Lists all the task in the task list.
+
+Format: `list`
+
 
-Description of the feature.
+    list    
+    ____________________________________________________________
+     Here are the tasks in your list:
+     1.[T][ ] borrow book
+     2.[D][ ] return book (by: Sunday)
+    ____________________________________________________________
 
-### Feature-XYZ
 
-Description of the feature.
+### Task Marking
 
-## Usage
+Keep track of Task completion.
+1. '[X]' Indicates Tasks that are completed, using mark command.
+2. '[ ]' Indicates Tasks that are not completed, using unmark command.
 
-### `Keyword` - Describe action
+Format: `mark {task index}`
 
-Describe the action and its outcome.
+Example: 
 
-Example of usage: 
+    mark 2
+    ____________________________________________________________
+     Nice! I've marked this task as done:
+       [D][X] return book (by: Sunday)
+    ____________________________________________________________
 
-`keyword (optional arguments)`
 
-Expected outcome:
+Format: `unmark {task index}`
 
-Description of the outcome.
+Example:
 
+    unmark 2
+    ____________________________________________________________
+     OK, I've marked this task as not done yet:
+       [D][ ] return book (by: Sunday)
+    ____________________________________________________________
+
+
+### Task Saving
+Store and retrieve your tasks into a dedicated save file.
 ```
-expected output
+   Loading previous list
+   Successfully wrote to the file.
 ```
+
+### Task Finding
+
+Search for keyword using the Find function.
+
+Format: `find {keyword}`
+
+    find book
+    ____________________________________________________________
+     Here are the matching tasks in your list:
+     1.[T][ ] borrow book
+     2.[D][ ] return book (by: Sunday)
+    ____________________________________________________________
+
+
+### Task Deletion
+
+Remove stored Tasks using the Delete function.
+
+Format: `delete {task index}`
+
+    delete 2
+    ____________________________________________________________
+     Noted. I've removed this task:
+       [D][ ] return book (by: Sunday)
+     Now you have 1 tasks in the list.
+    ____________________________________________________________
+
+
+### End Program
+Terminates the chatbot program.
+
+Format: `bye`
+

src/main/java/KenergeticBot.java

@@ -0,0 +1,56 @@
+import kenergeticbot.TaskList;
+import kenergeticbot.command.Command;
+import kenergeticbot.fileaccess.Storage;
+import kenergeticbot.ui.TextUi;
+import kenergeticbot.Parser;
+import kenergeticbot.command.ExitCommand;
+
+/**
+ * Entry point of the KenergeticBot chatbot.
+ * Initializes the application and starts the interaction with the user.
+ */
+public class KenergeticBot {
+    public static final String filePath = "data/KenergeticBot.txt";
+
+    private TextUi ui;
+    private Storage storage;
+    public TaskList taskList;
+
+    public static void main(String[] args) {
+        new KenergeticBot().run();
+    }
+
+    /**
+     * Sets up the required objects, loads up the data from the storage file, and prints the welcome message.
+     */
+    private void start(String filePath, TaskList taskList, TextUi ui) {
+        this.storage = new Storage(filePath, ui);
+        storage.loadPreviousList(taskList, ui);
+        ui.printGreetingMessage();
+    }
+
+    /** Runs the program until termination.  */
+    public void run() {
+        this.taskList = new TaskList();
+        this.ui = new TextUi();
+        start(filePath, taskList, ui);
+        runCommandLoopUntilExitCommand();
+        exit(ui);
+    }
+
+    /** Reads the user command and executes it, until the user issues the exit command.  */
+    public void runCommandLoopUntilExitCommand() {
+        do {
+            String item = ui.getUserCommand();
+            Command c = Parser.parseCommand(taskList, item);
+            c.execute(taskList, ui);
+        } while (!ExitCommand.isExit());
+        storage.saveList(taskList, ui);
+    }
+
+    /** Prints the Goodbye message and exits. */
+    private static void exit(TextUi ui) {
+        ui.printExitMessage();
+        System.exit(0);
+    }
+}

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

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