[Abdurrahman Faqih] iP

.gitignore

@@ -13,5 +13,9 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.txt
-text-ui-test/EXPECTED-UNIX.TXT
+# Text test files
+text-ui-test/*.txt
+
+# Data folder
+data/
+../../data/

README.md

@@ -1,26 +1,146 @@
-# Duke 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.
-
-## 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 dialog first)
-1. Set up the correct JDK version, as follows:
-   1. Click `Configure` > `Structure for New Projects` and then `Project Settings` > `Project` > `Project SDK`
-   1. If JDK 11 is listed in the drop down, select it. If it is not, click `New...` and select the directory where you installed JDK 11
-   1. Click `OK`
-1. Import the project into Intellij as follows:
-   1. Click `Open or Import`.
-   1. Select the project directory, and click `OK`
-   1. If there are any further prompts, accept the defaults.
-1. After the importing is complete, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+<h1>User Guide</h1>
+
+Duke Chatbot is a **desktop app for managing tasks and scehdules**. This chatbot uses a GUI text interface to interact with the user.
+
+- Quick Start
+- Features
+  - Help
+  - Adding a task:
+    - ToDo: `todo`
+    - Deadline: `deadline`
+    - Event: `event`
+  - Listing tasks: `list`
+  - Finding tasks based on keyword: `find`
+  - Marking tasks as done: `done`
+  - Deleting tasks: `delete`
+  - Exiting the program: `bye`
+- Command Summary
+
+<h2>Quick Start</h2>
+
+1. Ensure you have java `11` or newer installed in your computer.
+2. Download the latest release from [here](https://github.com/abdurrahmanfaqihiskandar/ip/releases).
+3. Add the `duke.jar` file into a directory of your choice to be used as your _home directory_.
+4. Double click the `duke.jar` file to launch the application.
+
+<h2>Features</h2>
+
+**Notes about the command format**:
+- Words in `UPPER_CASE` are the parameters to be supplied by the user.
+  E.g. in `todo DESCRIPTION`, `DESCRIPTION` is a parameter which can be used as `todo Clean the dishes`.
+
+<h3>Adding a task</h3>
+
+<h3>Adding a ToDo task:<code>todo</code></h3>
+
+Adds a todo task to the tasklist.
+
+Format: `todo DESCRIPTION`
+
+Examples:
+- `todo Clean the dishes`
+
+<h3>Adding a task with a deadline:<code>deadline</code></h3>
+
+Adds a task with a deadline to the tasklist. A task with a deadline needs to have a deadline date and time in the form `YYYY-MM-DD` and `HH:MM` respectively.
+
+Format: `deadline DESCRIPTION /by YYYY-MM-DD HH:MM`
+
+Example:
+- `deadline Project submisstion /by 2020-11-09 23:59`
+- `deadline Write my essay /by 2020-12-13 00:30`
+
+<h3>Adding an event task:<code>event</code></h3>
+
+Adds an event to the tasklist. An event needs to have an event date in the form `YYYY-MM-DD` and an event time range `HH:MM-HH:MM`.
+
+Format: `event DESCRIPTION /at YYYY-MM-DD HH:MM-HH:MM`
+
+Example:
+- `event Birthday party /at 2020-09-26 18:00-20:00`
+- `event History exam /at 2020-11-12 17:00-18:45`
+
+<h3>Listing tasks:<code>list</code></h3>
+
+Shows the list of tasks currently.
+There are a number of ways to list the tasks in the tasklist. Below are all the different ways to list tasks in the tasklist broken down into the type of tasks:
+- All tasks:
+  - List all tasks:<code>list all</code>
+  - List all tasks that are done:<code>list all done</code>
+  - List all tasks that are not done:<code>list all not done</code>
+- ToDo tasks:
+  - List all todo tasks:<code>list todos</code>
+  - List all todo tasks that are done:<code>list todos done</code>
+  - List all todo tasks that are not done:<code>list todos not done</code>
+- Tasks with a deadline:
+  - List all tasks with a deadline:<code>list deadlines</code>
+  - List all tasks with a deadline that are done:<code>list deadlines done</code>
+  - List all tasks with a deadline that are not done:<code>list deadlines not done</code>
+- Events:
+  - List all events:<code>list events</code>
+  - List all events that are done:<code>list events done</code>
+  - List all events that are not done:<code>list events not done</code>
+
+<h3>Finding tasks based on keyword:<code>find</code></h3>
+
+Find tasks whose names contain the keyword.
+
+Format: `find KEYWORD`
+- `KEYWORD` cannot be empty
+- The search is case-sensitive. E.g. `tEsT` will not match `test`.
+- Only the name is searched.
+- Part search will also match full words. E.g. `te` will match `test`.
+- The order of the keywords does not matter. E.g. `Exam Mock` will match `Mock Exam`.
+
+Examples:
+- `find party`
+- `find exam`
+
+<h3>Marking tasks as done:<code>done</code></h3>
+
+Marks tasks as done.
+
+Format: `done INDEX`
+- Marks the task at the specified `INDEX` as done.
+- The `INDEX` refers to the index number shown in the displayed task list.
+- The `INDEX` **must be a positive integer** 1, 2, 3, ...
+
+Examples:
+- `list all` to view all the tasks in the tasklist followed by `done 2` will mark the 2nd task as done.
+- `done 4` will mark the 4th task as done.
+
+<h3>Deleting tasks:<code>delete</code></h3>
+
+Deletes tasks from the tasklist.
+
+Format: `delete INDEX`
+- Deletes the task at the specified `INDEX`.
+- The `INDEX` refers to the index number shown in the displayed task list.
+- The `INDEX` **must be a positive integer** 1, 2, 3, ...
+
+Examples:
+- `list all` to view all the tasks in the tasklist followed by `delete 2` will delete 2nd task.
+- `delete 4` will delete the 4th task.
+
+<h3>Exiting the program:<code>bye</code></h3>
+
+Exits the program and closes the application.
+
+Format:`bye`
+
+<h3>Saving the data</h3>
+
+Duke automatically saves the tasklist in the hard disk after any command that changes the data. There is no need to save manually.
+
+<h2>Command Summary</h2>
+
+| Action | Format, Examples |
+| --- | --- |
+| todo | `todo DESCRIPTION`, e.g. `todo Clean the dishes` |
+| deadline | `deadline DESCRIPTION /by YYYY-MM-DD HH:MM`, e.g. `deadline Project submisstion /by 2020-11-09 23:59` |
+| event | `event DESCRIPTION /at YYYY-MM-DD HH:MM-HH:MM`, e.g. `event Birthday party /at 2020-09-26 18:00-20:00` |
+| list | `list PARAMETER`, e.g. `list events done` |
+| find | `find KEYWORD`, e.g. `find homework` |
+| done | `done INDEX`, e.g. `done 2`
+| delete | `delete INDEX`, e.g. `delete 1`
+| bye | `bye` |

build.gradle

@@ -0,0 +1,61 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
+    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+
+    String javaFxVersion = '11'
+
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+}
+
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+        showStandardStreams = false
+    }
+}
+
+application {
+    mainClassName = "duke.Launcher"
+}
+
+shadowJar {
+    archiveBaseName = "duke"
+    archiveClassifier = null
+}
+
+checkstyle {
+    toolVersion = '8.23'
+}
+
+run {
+    standardInput = System.in
+}