[Luah Jun Yang} iP

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: Frenchie.Frenchie
+

README.md

@@ -1,24 +1,151 @@
-# 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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# Frenchie User Guide
+
+## Features 
+
+### Feature 1 - Storing tasks
+
+Storing of 3 different tasks:
+1. To Do (with no deadline)
+2. Deadlines (with a deadline)
+3. Events (with a Start and End time)
+
+### Feature 2 - Listing of stored tasks
+### Feature 3 - Marking tasks as done/undone
+### Feature 4 - Deleting tasks from the list
+### Feature 5 - Searching for all tasks containing any keyword
+
+## Usage
+
+### `todo` - Adds a ToDo type task into the list
+
+
+
+Example of usage: 
+
+`todo read book`
+
+Expected outcome:
+
+Frenchie will return this message for successfully adding a task to the list. [T] represents a ToDo task and the [ ] indicates the task is not yet completed.
+ ```
+Got it! I've added this task:
+
+[T][ ] read book
+
+Now you have X tasks in the list.
+```
+
+### `deadline` - Adds a Deadline type task into the list. 
+
+Deadline has to be in format dd/MM/yyyy HH:mm.
+
+Example of usage:
+
+`deadline read book /by 09/09/2023 18:00`
+
+Expected outcome:
+
+Frenchie will return this message for successfully adding a task to the list. [D] represents a Deadline task and the [ ] indicates the task is not yet completed.
+ ```
+Got it! I've added this task:
+
+[D][ ] read book (by: 2023-09-09 18:00).
+
+Now you have X tasks in the list.
+```
+
+### `event` - Adds an event type task into the list
+
+Start and end time of event have to be in format dd/MM/yyyy HH:mm.
+Example of usage:
+
+`todo read book /from 09/09/2023 18:00 /to 09/09/2023 19:00`
+
+Expected outcome:
+
+Frenchie will return this message for successfully adding a task to the list. [E] represents an event task and the [ ] indicates the task is not yet completed.
+ ```
+Got it! I've added this task:
+
+[E][ ] read book (from: 2023-09-09 18:00 to: 2023-09-09 19:00)
+
+Now you have X tasks in the list.
+```
+
+### `list` - lists all tasks currently stored in Frenchie
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+```
+1. [T][ ] read book
+2. [D][ ] read book (by: 2023-09-09 18:00)
+3. [E][ ] read book (from: 2023-09-09 18:00 to: 2023-09-09 19:00)
+```
+
+### `mark` - mark the specified task as complete
+
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
+
+```
+Nice! I've marked this task as done:
+[T][X] read book
+```
+
+### `unmark` - mark the specified task as complete
+
+Example of usage:
+
+`unmark 1`
+
+Expected outcome:
+
+```
+OK, I've marked this task as not done yet:
+[T][ ] read book
+```
+
+### `delete` - delete the specified task from the list
+
+Example of usage:
+
+`delete 1`
+
+Expected outcome:
+
+```
+Noted. I've removed this task:
+[T][ ] read book 
+Now you have X tasks in the list.
+```
+
+### `find` - search through the list and returns all tasks that contain the keyword
+
+Example of usage:
+
+`find book`
+
+Expected outcome:
+
+```
+Here are the matching tasks in your list:
+1. [D][ ] read book (by: 2023-09-09 18:00)
+2. [E][ ] read book (from: 2023-09-09 18:00 to: 2023-09-09 19:00)
+```
+
+### `help` - returns a quickstart guide for users who have forgotten any command
+
+Example of usage:
+
+`help`
+
+Expected outcome:
+
+A quickstart guide for Frenchie listing the commands.

build.gradle

@@ -0,0 +1,62 @@
+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("Frenchie.Launcher")
+}
+
+shadowJar {
+    archiveBaseName = "Frenchie"
+    archiveClassifier = null
+    archiveFileName = "Frenchie.jar"
+    dependsOn("distZip", "distTar")
+}
+
+run{
+    standardInput = System.in
+    enableAssertions = true
+}