[Ria Khaitan] iP

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+*.class

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# duke.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.
 
@@ -13,7 +13,7 @@ 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 file, right-click it, and choose (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
     ____        _        

build.gradle

@@ -0,0 +1,63 @@
+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'
+}
+
+dependencies {
+    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.29'
+}
+
+run{
+    standardInput = System.in
+}

data/duke.txt

@@ -0,0 +1,2 @@
+[T][ ]/home
+[T][ ]/party

docs/README.md

@@ -1,29 +1,132 @@
 # User Guide
 
+Hi This is Halloumi ^_^. 
+I can keep track of your tasks, deadlines and events for you, and am your own personal tasks manager.
+
 ## Features 
 
-### Feature-ABC
+1. **ToDo** : A simple task with only a description that.
+2. **Deadline** : A task with a specific deadline that needs to be completed before that deadline.
+3. **Event** : A task that is going to happen occur on a specific date.
 
-Description of the feature.
+## Usage
 
-### Feature-XYZ
+### `todo` - add a todo task into the task list.
 
-Description of the feature.
+using this keyword with a description will add a todo task in the list.
 
-## Usage
+Example of usage: 
+
+`todo read book`
+
+Expected outcome:
+
+this will add the task of reading a book to the list.
+
+```
+New task added:
+[T][ ] read book
+```
+
+### `deadline` - add a deadline task into the task list.
+
+using this keyword with a description and a date after "/by" will add a deadline task in the list.
+
+Example of usage: 
+
+`deadline finish project /by 2022-06-10`
+
+Expected outcome:
+
+this will add the deadline task of finishing a project and set the deadline as June 10 2022.
+
+```
+New task added:
+[D][ ] finish project (by: Jun 10 2022)
+```
+
+### `event` - add an event task into the task list.
+
+using this keyword with a description and a date after "/at" will add a event task in the list.
+
+Example of usage: 
+
+`event go party /at 2022-06-10`
+
+Expected outcome:
+
+this will add the event task of going to a party and set the event date as June 10 2022.
+
+```
+New task added:
+[E][ ] go party (at: June 10 2022)
+```
+
+### `mark` - marks a task as completed
+
+using this keyword with a task number from the list will mark that task as complete
+Example of usage: 
+
+`mark 6`
+
+Expected outcome:
+
+this will mark the 6th task in the list as complete
+
+```
+Good Job! ^_^
+Task number 6 has been marked as done!
+[D][X] finish project (by: Jun 10 2022)
+```
+
+### `unmark` - marks a task as incompleted
+
+using this keyword with a task number from the list will mark that task as incomplete
+Example of usage: 
+
+`unmark 6`
+
+Expected outcome:
+
+this will mark the 6th task in the list as incomplete
+
+```
+I've unmarked task number 6
+Complete it soon! ^_^
+[D][ ] finish project (by: Jun 10 2022))
+```
+### `delete` - delete a task
+
+using this keyword with a task number from the list will delete that task from the list
+
+Example of usage: 
+
+`delete 6`
+
+Expected outcome:
+
+this will delete the 6th task in the list
+
+```
+Noted. I've removed this task:
+[D][ ] finish project (by: Jun 10 2022)
+```
 
-### `Keyword` - Describe action
+### `find` - find a task
 
-Describe the action and its outcome.
+using this keyword with a keyword will find the tasks where the description contain that keyword
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`find run`
 
 Expected outcome:
 
-Description of the outcome.
+this will find all the tasks where the description contains 'run'
 
 ```
-expected output
+Here are the matching tasks:
+1. [T][ ] run
+2. [D][ ] run (by: Jan 2 2007)
+3. [E][ ] run (at: Jan 2 2007)
 ```

docs/_config.yml

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

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.2-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists