[Tan Gee Teng] iP

README.md

@@ -1,24 +1,11 @@
-# Duke project template
+# BMO Assistant
 
-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 Software Engineering academic project done by using a greenfield Java project template,
+[Duke](https://github.com/nus-cs2103-AY2122S2/ip). It is an application to help user keep track of tasks, deadlines
+and events. Given below is the instruction for installing the application. 
 
-## Setting up in Intellij
+### Setting up BMO Assistant
 
-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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+* Follow this [link](https://github.com/geetengtan/BMO-Assistant/releases/tag/A-Release) and install the duke.jar file
+   within the Assets.
+* Refer to the [User Guide](https://geetengtan.github.io/BMO-Assistant/) to familiarise yourself with the application.

build.gradle

@@ -0,0 +1,61 @@
+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'
+
+    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 = "Launcher"
+}
+
+shadowJar {
+    archiveBaseName = "duke"
+    archiveClassifier = null
+}
+
+checkstyle {
+    toolVersion = '8.29'
+}
+
+run{
+    standardInput = System.in
+}

data/duke.txt

@@ -0,0 +1,3 @@
+T#true#borrow book
+D#false#return book #2022-03-11
+D#false#CS2103 iP #2022-02-18

docs/UserGuide.md

@@ -0,0 +1,204 @@
+# User Guide
+
+## Features 
+- Task List
+- Personalised Notes
+
+### Task List
+
+Task List helps you organise your tasks, keep track of progress and can remind you of deadlines and events.
+
+### Personalised Notes
+
+Personalised Notes can help you record important stuffs that you might want to refer to any time. 
+
+## Usage
+
+### `list` - view Task List
+
+The current Task List is printed. A task has the following format:
+`[type of task][makred/unmarked] description (date of task)` 
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+```
+Here are the tasks in your list:
+  1. [T][X] borrow book
+  2. [D][ ] return book (Mar 11 2022)
+  3. [D][ ] CS2103 iP (Feb 18 2022)
+  4. [E][ ] party at Evan's (Feb 27 2022)
+```
+
+
+
+### `todo [description]` - add a todo task to Task List
+
+Add a todo task to your Task List. Todo task supports task description feature only.
+
+Example of usage:
+
+`todo borrow book`
+
+Expected outcome:
+
+A new task `todo` will be added to your Task List and labelled [T] for **T**odos. Todos support task description 
+
+```
+Got it. BMO has added this task:
+    [T][ ] borrow book
+Now you have 1 task in your list.
+```
+
+
+
+### `deadline [description] /[yyyy-mm-dd]` - add a deadline to Task List
+
+Example of usage: 
+
+`deadline return book /2022-03-11`
+
+Expected outcome:
+
+A new task `deadline` will be added to your Task List and labelled [D] for **D**eadlines. Deadlines support task description and date
+
+```
+Got it. BMO has added this task:
+    [D][ ] return book (Feb 27 2022)
+Now you have 2 tasks in your list.
+```
+
+
+
+### `event [description] /[yyyy-mm-dd]` - add an event to Task List
+
+Example of usage:
+
+`event party at Evan's /2022-02-27`
+
+Expected outcome:
+
+A new task `event` will be added to your Task List and labelled [E] for **E**vents. Events support task description and date.
+
+```
+Got it. BMO has added this task:
+    [E][ ] party at Evan's (Feb 27 2022)
+Now you have 3 tasks in your list.
+```
+
+
+
+### `mark [index]` - mark a task
+
+Marks the task according to the index of the Task List.
+
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
+
+The indexed task will be marked and shown.
+
+```
+Awesome! :D Another task done:
+    [T][X] borrow book
+```
+
+
+
+### `unmark [index]` - unmark a task
+
+Unmarks the task according to the index of the Task List.
+
+Example of usage:
+
+`unmark 1`
+
+Expected outcome:
+
+The indexed task will be unmarked and shown.
+
+```
+T_T BMO hate it when you lie. I will unmark this task:
+    [T][ ] borrow book
+```
+
+
+
+### `delete [index]` - delete a task
+
+Deletes the task according to the index of the Task List.
+
+Example of usage:
+
+`delete 1`
+
+Expected outcome:
+
+The indexed task will be unmarked and shown.
+
+```
+BMO deleted the task. Yay!:
+    [T][X] borrow book
+```
+
+
+
+### `note [label]: [description]` - add a new note to your Personalised Notes
+
+Adds a new note with a label and a description. Notes are referred to by their labels instead of index.
+
+Example of usage:
+
+`note StudentID: A0123456M`
+
+Expected outcome:
+
+New note added to Personalised Notes. `label` of the note is StudentID and `description` of the note is A0123456M. 
+
+```
+BMO added this to your notes:
+    StudentID: A0123456M
+```
+
+
+
+### `checknote` - check your Personalised Notes
+
+Checks your Personalised Notes.
+
+Example of usage:
+
+`checknote`
+
+Expected outcome:
+
+The current list of Personalised Notes.
+
+```
+Here are your notes:
+    StudentID: A0123456M
+```
+
+
+
+### `deletenote [label]` - delete a note
+
+Deletes a note with the label given.
+
+Example of usage:
+
+`deletenote StudentID`
+
+Expected outcome:
+
+Note with label StudentID is deleted from Personalised Notes.
+
+```
+Deleted this note:
+    StudentID: A0123456M
+```

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,11 @@
+#Wed Feb 02 12:10:36 MYT 2022
+distributionBase=GRADLE_USER_HOME
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.1-bin.zip
+distributionPath=wrapper/dists
+<<<<<<< HEAD
+=======
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+>>>>>>> branch-A-JavaDoc
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME