[Ryan-Reno] iP

.gitignore

@@ -13,5 +13,7 @@ src/main/resources/docs/
 *.iml
 bin/
 
+/data/
+
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT

README.md

@@ -1,24 +1,187 @@
-# 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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# Lite User Guide
+
+Lite is a user-friendly chatbot, especially designed towards
+forgetful students to keep track of their ToDos, Events, and Deadlines.
+Lite will be able to keep track the dates and status of completion of tasks,
+allowing better planning for your future tasks.
+
+## Downloading and running the file
+Prerequisite: Ensure that java and JDK 11 is downloaded on your computer
+
+1. Go to Releases > iP v0.2 > lite.jar
+2. Run lite.jar by typing ./lite.jar or java -jar lite.jar in the Terminal
+
+## List of Features
+
+- [x] Adding ToDo task
+- [x] Adding Event task
+- [x] Adding Deadline task
+- [x] Mark tasks as done
+- [x] Unmark tasks as undone
+- [x] Keep track and list out all of the added tasks
+- [x] Delete tasks from the list
+- [x] Find a task using a keyword
+- [x] Close the program
+- [ ] Reminder (Coming soon)
+
+
+## Adding Todo task
+
+Allows users to add a ToDo task that has no date.
+
+Format: todo [description]
+
+Example: `todo return a book`
+
+Expected output:
+
+```
+Got it. I've added this task:
+[T][] return a book
+Now you have <x> tasks in the list
+```
+
+## Adding Deadline Task
+
+Allows users to add a Deadline task that has a due date.
+
+Format: deadline [DESCRIPTION] /by [DATE].
+- The date has to be in the format of YYYY-MM-DD, and a time from 00:00 to 23:59.
+
+Example: deadline 2103T Assignment /by 2024-02-20 23:59
+
+
+Expected output:
+
+```
+Got it. I've added this task:
+[D][] 2103T Assignment (by: FEBRUARY 20 2024 23:59)
+Now you have <x> tasks in the list
+```
+
+
+## Adding Event Task
+
+Allows users to add a Event task that has a start date and end date.
+
+Format:event [DESCRIPTION] /from [DATE] /to [DATE]
+- The date has to be in the format of YYYY-MM-DD, and a time from 00:00 to 23:59.
+
+Example: event 2101 group meeting /from 2024-02-20 17:30 /to 2024-02-20 18:30
+
+
+Expected output:
+
+```
+Got it. I've added this task:
+[E][] 2101 group meeting (from: FEBRUARY 20 2024 17:30 to: 
+FEBRUARY 20 2024 18:30)
+Now you have <x> tasks in the list
+```
+
+## Mark Tasks as Done
+
+Allow users to mark their tasks as completed
+
+Format: mark INDEX
+
+Example: mark 1
+
+Assuming that the very first task you added was the ToDo task of returning a book,
+this is the expected output:
+
+```
+This task has been marked as done!
+[T][X] return a book
+```
+
+## Unmark Tasks
+
+Similarly, you can also unmark your tasks to undo it. This is mainly to undo
+if you incorrectly marked your task as done.
+
+Format: unmark INDEX
+
+Example: unmark 1
+
+Assuming that the very first task you added was the ToDo task of returning a book,
+this is the expected output:
+
+```
+This task has been unmarked!
+[T][] return a book
+```
+
+## List out all the tasks added
+
+Allow users to see the list of tasks that they have added so far.
+It also keeps track of the tasks that may have been added before
+
+Format: list
+
+Assuming that you had added a todo, deadline, and event task in that respective order,
+this is the expected output:
+
+```
+1. [T][] return a book
+2. [D][] 2103T Assignment (by: FEBRUARY 20 2024 23:59)
+3. [E][] 2101 group meeting (from: FEBRUARY 20 2024 17:30 to: 
+FEBRUARY 20 2024 18:30)
+```
+
+
+## Delete Tasks
+
+Allow users to delete the tasks that are in the list
+
+Format: delete INDEX
+
+Example: delete 1
+
+Assuming that the very first task you added was the ToDo task of returning a book,
+this is the expected output:
+
+```
+Noted. I've removed this task:
+[T][] return a book
+Now you have <x> tasks in the list
+```
+
+Also note that if you delete a task, all the index after that task will drop by 1.
+So if you had added all a todo, deadline, event tasks all in order, calling list will result in this output:
+
+```
+Here are the tasks in your list:
+1. [D][] 2103T Assignment (by: FEBRUARY 20 2024 23:59)
+2. [E][] 2101 group meeting (from: FEBRUARY 20 2024 17:30 to: 
+FEBRUARY 20 2024 18:30)
+```
+
+## Finding a task using a keyword
+Allow users to find a task that contains a specified word
+
+Format: find [KEYWORD]
+- The search is case-sensitive e.g book will not find Book
+- The search uses partial search e.g gro will find group
+
+
+Example: find Assignment
+
+Expected output:
+```
+Here are the matching tasks in your list:
+1. [D][] 2103T Assignment (by: FEBRUARY 20 2024 23:59)
+```
+
+
+## Terminating the program
+Aside from clicking the X button on the top right, you can also provide
+a command to close the app. This command is "bye" (without the " ")
+
+Format: bye
+
+
+Note that it is case-sensitive, so it must be exactly the same as bye
+
+
+

build.gradle

@@ -0,0 +1,57 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'com.github.johnrengelman.shadow' version '7.1.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("lite.Lite")
+}
+
+shadowJar {
+    archiveBaseName = "lite"
+    archiveClassifier = null
+    dependsOn("distZip", "distTar")
+}
+
+run{
+    standardInput = System.in
+}