[Ernest Yu] iP

README.md

@@ -1,24 +1,13 @@
-# Duke project template
+# Bword chatbot
 
-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.
+This is a greenfield Java project. It's adapted after the Java mascot _Duke_. Given below are instructions on how to use it.
 
-## Setting up in Intellij
+## Running the program
 
-Prerequisites: JDK 17, update Intellij to the most recent version.
+You can do one of the following to run the program
+1. Run the jar file, if you prefer the GUI interface
+2. Run Bword
 
-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 17** (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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+for 2, you will need to enter the following commands in bash after navigating to the directory with Bword
+```javac Bword.java```
+```java Bword```

build.gradle

@@ -0,0 +1,63 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
+    id 'checkstyle'
+}
+
+checkstyle {
+    toolVersion = '10.2'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    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'
+
+    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'
+}
+
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+        showStandardStreams = false
+    }
+}
+
+application {
+    mainClass.set("Launcher")
+}
+
+shadowJar {
+    archiveBaseName = "Bword"
+    archiveClassifier = null
+}
+
+run{
+    standardInput = System.in
+}
+
+mainClassName = 'Launcher'

data/bword.txt

@@ -0,0 +1,9 @@
+todo abc
+todo adasjdfkasnf
+todo ffff
+todo tttt
+todo llll
+todo xxx
+todo abcdefghi
+todo adkjadn
+todo asdkasfd

docs/README.md

@@ -1,30 +1,111 @@
-# Duke User Guide
+# Bword User Guide
+Hi from Bword, your ex girlfriend / boyfriend / otherfriend who keeps tasks for you >:(
+![Ui](https://github.com/user-attachments/assets/d84b365e-764f-4beb-913b-7c073a72def6)
 
-// Update the title above to match the actual product name
+## Getting started 101
+Ensure that you are running java 17 on your machine. You may check your java version by entering java -version in the command line.
 
-// Product screenshot goes here
+Copy the jar file into your terminal and run it with the following command:
+```java -jar Bword.java```
 
-// Product intro goes here
+## Running the program 101
 
-## Adding deadlines
+Here the list of features we have!
 
-// Describe the action and its outcome.
+**Add Tasks:** Create new to-do items, deadlines, or events.
 
-// Give examples of usage
+**List Tasks:** Display all current tasks.
 
-Example: `keyword (optional arguments)`
+**Mark Tasks:** Mark tasks as completed or uncompleted.
 
-// A description of the expected outcome goes here
+**Delete Tasks:** Remove tasks from the list.
 
+**Find Tasks:** Search for tasks by keyword.
+
+## How to get help 101 
+
+type the following to receive help:
+1. help - for listing all the commands
+2. help <command> - for listing command format for specific commands
+
+Commands:
+```
+help
+help <command>
+```
+
+Example
+```
+help
+help todo
+```
+
+
+## Adding Tasks 101
+
+This will add to your task list
+Commands:
+```
+todo <description>
+deadline <description> /by <yyyy-mm-dd>
+event <description> /from <yyyy-mm-dd> /to <yyyy-mm-dd>
+```
+
+Example
+```
+todo buy groceries
+deadline submit assignment /by 2023-12-10
+event team meeting /from 2023-12-01 /to 2023-12-01
+```
+
+## Listing Tasks 101
+
+This will list all the tasks
+Command:
+
+```list```
+
+## Marking / Unmarking Tasks 101
+
+This will mark / unmark tasks accordingly
+Commands:
 ```
-expected output
+mark <task number>
+unmark <task number>
 ```
 
-## Feature ABC
+## Deleting Tasks 101
+
+This will Delete a task
+Command:
+
+```delete <task number>```
+
+## Finding Tasks
+
+This will Find a task in your list
+
+Command:
+
+```find <keyword>```
+
+Example:
+
+```find meeting```
+
+## Feature: Error Handling
+If you make a mistake, the bot scolds you duh.
+
+Example:
+
+```todo```
 
-// Feature details
+Response:
 
+```Task Description is empty.```
 
-## Feature XYZ
+## Closing the app 101
+Press the x button of the app lah, need me to teach you meh
 
-// Feature details
+## Acknolwedgements
+I would like to thank you for choosing your ex to be you B****

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists