[Lee Bing Heng] iP

.gitignore

@@ -15,3 +15,9 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+# Java class files
+*.class
+
+# Data folder for csv
+/data

README.md

@@ -1,24 +1,87 @@
-# 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 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/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:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# Duke User Guide
+
+Welcome to the Duke the Chatbot! This chatbot is designed to help you store and display information about your upcoming events using a Command Line Interface (CLI). Below is a list of available commands and their descriptions:
+
+## Available Commands
+
+### 1. List
+
+- Command: `list`
+- Parameters: None
+- Description: List all upcoming events.
+- Usage: `list`
+
+### 2. Mark
+
+- Command: `mark (i)`
+- Parameters:
+  - `i`: The index of the event to mark (must be an integer).
+- Description: Mark the specified event in the list of events.
+- Usage: `mark 1` (to mark the first event)
+
+### 3. Unmark
+
+- Command: `unmark (i)`
+- Parameters:
+  - `i`: The index of the event to unmark (must be an integer).
+- Description: Unmark the specified event.
+- Usage: `unmark 1` (to unmark the first event)
+
+### 4. Todo
+
+- Command: `todo (name)`
+- Parameters:
+  - `name`: The name of the todo event (represented by a string).
+- Description: Add a todo event with the provided name.
+- Usage: `todo Buy groceries`
+
+### 5. Event
+
+- Command: `event (name) /from (datetime) /to (datetime)`
+- Parameters:
+  - `name`: The name of the event.
+  - `datetime`: The start and end date and time of the event.
+- Description: Add an event with a name, start date, and end date.
+- Usage: `event Birthday Party /from 2023-10-15 15:00 /to 2023-10-15 18:00`
+
+### 6. Deadline
+
+- Command: `deadline (name) /by (datetime)`
+- Parameters:
+  - `name`: The name of the deadline event.
+  - `datetime`: The deadline date and time.
+- Description: Add a deadline event with a name and a specified deadline.
+- Usage: `deadline Submit Report /by 2023-11-01 23:59`
+
+### 7. Find
+
+- Command: `find (name)`
+- Parameters:
+  - `name`: The keyword to search for within event names.
+- Description: Find event names that match the provided string.
+- Usage: `find Party`
+
+### 8. Upcoming
+
+- Command: `upcoming`
+- Parameters: None
+- Description: List all events in ascending order of their datetime.
+- Usage: `upcoming`
+
+### 9. Bye
+
+- Command: `bye`
+- Parameters: None
+- Description: Exit the program.
+- Usage: `bye`
+
+## Example Usage
+
+- To list all upcoming events: `list`
+- To mark the first event: `mark 1`
+- To add a todo event: `todo Buy groceries`
+- To add an event with a specific date and time: `event Birthday Party /from 2023-10-15 15:00 /to 2023-10-15 18:00`
+- To find events with the keyword "Party" in their names: `find Party`
+- To exit the program: `bye`
+
+Feel free to use these commands to manage your upcoming events effectively with the chatbot. Enjoy using Duke!

build.gradle

@@ -0,0 +1,65 @@
+plugins {
+    id 'checkstyle'
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
+}
+
+repositories {
+    mavenCentral()
+}
+
+checkstyle {
+    toolVersion = '10.2'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    String javaFxVersion = '17.0.7'
+
+    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'
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
+    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
+}
+
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+        showStandardStreams = false
+    }
+}
+
+application {
+    mainClass.set("duke.Duke")
+}
+
+shadowJar {
+    archiveFileName = "duke.jar"
+    //archiveClassifier = null
+    //dependsOn("distZip", "distTar")
+}
+
+run{
+    standardInput = System.in
+}