[Ryan Jee] iP

README.md

@@ -1,23 +1,17 @@
-# Duke project template
+# Duke bot 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
+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).
-1. After that, 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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+Open Intellij (if you are not in the welcome screen, click File > Close Project to close the existing project dialog first)
+Set up the correct JDK version, as follows:
+Click Configure > Structure for New Projects and then Project Settings > Project > Project SDK
+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
+Click OK
+Import the project into Intellij as follows:
+Click Open or Import.
+Select the project directory, and click OK
+If there are any further prompts, accept the defaults.

build.gradle

@@ -0,0 +1,56 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id "com.github.johnrengelman.shadow" version "6.0.0"
+}
+
+group 'org.example'
+version '1.0-SNAPSHOT'
+
+repositories {
+    mavenCentral()
+}
+sourceSets {
+    main {
+        java {
+            srcDirs = ['src']
+        }
+    }
+
+}
+
+
+dependencies {
+    compile 'junit:junit:4.12'
+}
+run {
+    enableAssertions = true
+}
+test {
+    useJUnitPlatform()
+}
+
+dependencies {
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.4.0'
+    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.4.0'
+    implementation 'org.junit.jupiter:junit-jupiter-api:5.5.1'
+    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'
+}
+checkstyle {
+    toolVersion = '8.23'
+}
+mainClassName ="main.duke.gui.Launcher"

data/duke.txt

@@ -0,0 +1,2 @@
+E~1~tosleep~2020-01-01 2401
+T~0~sample

docs/README.md

@@ -1,20 +1,126 @@
 # User Guide
+Duke bot is a chat bot designed to be used via a command line interface(CLI) with the benefits of using a graphical user interface(GUI). 
 
 ## Features 
+>list : prints you the list of store tasks<br>
+bye : terminates the program<br>
+help : prints descriptions and samples of each feature<br>
+todo [your task input] : adds a todo type task<br>
+event [your task input] /at [YYYY-MM-DD hhmm]: adds an event type task<br>
+deadline [your task input] /by [YYYY-MM-DD hhmm]: adds a deadline type task<br>
+delete[number] : deletes the selected task<br>
+done[number] : make the selected task done<br>
+find [search string] : finds tasks that matches the string description<br>
 
-### Feature 1 
-Description of feature.
+### `list` - prints you the list of store tasks 
+
+
+Example of usage: 
+
+`list`
+
+Expected outcome:
+
+`These are the tasks in your list:
+ 1.[T] [X] sample`
+
+### `bye` - terminates the program
+
+
+Example of usage: 
+
+`bye`
+
+Expected outcome:
+
+`Goodbye!`
+
+### `help` - prints descriptions and samples of each feature
+
+
+Example of usage: 
+
+`help`
+
+Expected outcome:
+
+![Duke_Interface](Help.PNG)
+### `todo` - adds a todo type task
+
+
+
+Example of usage: 
+
+`todo sleep`
+
+Expected outcome:
+
+>Added the following task: <br>
+> [T][X] sleep<br>
+>You now have 1 tasks in your list
+
+### `event` - adds an event type task
 
-## Usage
 
-### `Keyword` - Describe action
+
+Example of usage: 
+
+`event tosleep /at 2020-01-01 1111`
+
+Expected outcome:
+
+>Added the following task:<br>
+> [E][X] tosleep 2020-01-01 1111
+>You now have 1 tasks in your list
+
+### `deadline` - adds a deadline type task
+
+
+Example of usage: 
+
+`deadline wakeup /by 2020-01-01 1111`
+
+Expected outcome:
+
+>Added the following task:<br>
+> [D][X] wakeup 2020-01-01 1111
+>You now have 1 tasks in your list
+
+### `delete` - deletes the selected task
+
+
+Example of usage: 
+
+`delete 1`
+
+Expected outcome:
+
+>The following task has been removed:<br>
+> [T][X] sample
+>You now have 0 tasks in your list
+
+### `done` - make the selected task done
 
 Describe action and its outcome.
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`done 1`
+
+Expected outcome:
+
+>Following task has been marked done:<br>
+>[T][O] sample
+
+### `find` - finds tasks that matches the string description
+
+
+Example of usage: 
+
+`find sample`
 
 Expected outcome:
 
-`outcome`
+>Here are the tasks you asked for:<br>
+>1. [T][X] sample
+

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-time-machine

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Tue Feb 23 16:47:37 SGT 2021
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-all.zip
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME