Michael Ong iP

README.md

@@ -1,23 +1,135 @@
-# 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).
-1. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# User Guide
+Welcome to MAGATRON!
+
+MAGATRON is here to help you keep log important events and keep track of impending deadlines.
+
+MAGATRON has a CLI (command-line interface). The valid commands are listed below in "Features".
+
+## Features 
+
+### Managing Tasks
+MAGATRON helps you log tasks. Tasks are split into 3 categories. 
+* todo
+* deadline
+* event
+
+MAGATRON allows you to add, view, mark-as-done and delete these tasks whenever necessary.
+Deadline tasks have an additional feature, reminder, that updates you how long you have left
+until the deadline for the task.
+
+## Commands
+
+### Adding Tasks to the TaskList
+
+* #### `todo` - Adds Todo task
+
+  Adds a "todo" task to your task list.
+  Todo tasks do not have specified due by date or other additional information
+
+Example of usage:
+
+    todo Clean the floor
+
+Expected outcome:
+
+    Got it! I've added this new Task!
+    [T][x] Clean the floor
+    Now you have 1 task in your TaskList.
+
+* #### `deadline` - Adds Deadline task
+
+  Adds a "Deadline" to your task list.
+  Deadline tasks have a description and a due date. 
+  They are split using a " /by "
+  Dates have to follow convention of YYYY-MM-DD.
+
+
+Example of usage:
+
+    deadline homework /by 2021-03-03
+
+Expected outcome:
+
+    Got it! I've added this new Task!
+    [D][x] homework by (by: 2021-03-03)
+    Now you have 2 tasks in your TaskList.
+
+* #### `event` - Adds Event
+
+  Adds an "event" task to your task list.
+  Event tasks have a description and location. 
+  They are split using a " /at ". Locations do not have to 
+  follow any convention.
+
+
+Example of usage:
+
+    event Party /at Clementi Mall
+
+Expected outcome:
+
+    Got it! I've added this new Task!
+    [E][x] Party (at: Clementi Mall)
+    Now you have 3 tasks in your TaskList.
+
+### Managing the TaskList
+
+* #### `list` - lists all the logged tasks
+
+  "List" all tasks from your task list.
+
+Example of usage:
+
+    list
+
+Expected outcome:
+
+    Here are your remainding tasks!
+    1. [T][x] Clean the floor
+    2. [D][x] homework by (by: 2021-03-03)
+    3. [E][x] Party (at: Clementi Mall)
+
+* #### `delete` - Deletes Task
+
+  **Delete** a task from your task list.
+
+Example of usage:
+
+    delete 3
+
+Expected outcome:
+
+    Noted! I have removed this task from the list.
+    [E][x] Party (at: Clementi Mall)
+
+* #### `find` - Finds Tasks
+
+  "Finds" the tasks from your TaskList containing the given keyword.
+  keywords are only compared to the description of each task.
+
+Example of usage:
+
+    find Clean the floor
+
+Expected outcome:
+
+    Here are the relevant tasks:
+    1. [T][x] Clean the floor
+
+* #### `reminder` - reminds you of impending deadline 
+  "reminder" shows a list of all impending deadline tasks in order of
+  days till the deadline.
+
+Example of usage:
+
+    reminder
+
+Expected outcome:
+
+    Here are your upcoming deadline Tasks!
+    1. [D][x] homework by (by: 2021-03-03) x days left!!
+
+
+## Acknowledgement
+
+Reused @banchiang code for GUI implementation.

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

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 = "duke.Duke"
+}
+
+shadowJar {
+    archiveBaseName = "duke"
+    archiveClassifier = null
+}
+
+checkstyle {
+    toolVersion = '8.29'
+}
+
+run{
+    standardInput = System.in
+}

data.txt

@@ -0,0 +1,12 @@
+[E][✓] party (at: Clementi Mall)
+[D][✘] assignment (by: 2021-03-03)
+[D][✘] deadlineadad (by: 2020-01-01)
+[D][✘] deadlines (by: 2023-12-12)
+[D][✘] task1 (by: 2031-12-12)
+[D][✘] deadlines (by: 2020-12-12)
+[D][✘] deadline123 (by: 2012-12-12)
+[D][✘] valid deadline (by: 2030-12-12)
+[D][✘] deadline (by: 2040-12-12)
+[T][✘] hi
+[E][✘] event (at: place)
+[D][✘] deadline (by: 1999-12-12)

docs/README.md

@@ -1,20 +1,135 @@
 # User Guide
+Welcome to MAGATRON!
+
+MAGATRON is here to help you keep log important events and keep track of impending deadlines.
+
+MAGATRON has a CLI (command-line interface). The valid commands are listed below in "Features".
 
 ## Features 
 
-### Feature 1 
-Description of feature.
+### Managing Tasks
+MAGATRON helps you log tasks. Tasks are split into 3 categories. 
+* todo
+* deadline
+* event
+
+MAGATRON allows you to add, view, mark-as-done and delete these tasks whenever necessary.
+Deadline tasks have an additional feature, reminder, that updates you how long you have left
+until the deadline for the task.
+
+## Commands
+
+### Adding Tasks to the TaskList
+
+* #### `todo` - Adds Todo task
+
+  Adds a "todo" task to your task list.
+  Todo tasks do not have specified due by date or other additional information
+
+Example of usage:
+
+    todo Clean the floor
+
+Expected outcome:
+
+    Got it! I've added this new Task!
+    [T][x] Clean the floor
+    Now you have 1 task in your TaskList.
+
+* #### `deadline` - Adds Deadline task
+
+  Adds a "Deadline" to your task list.
+  Deadline tasks have a description and a due date. 
+  They are split using a " /by "
+  Dates have to follow convention of YYYY-MM-DD.
+
+
+Example of usage:
+
+    deadline homework /by 2021-03-03
+
+Expected outcome:
+
+    Got it! I've added this new Task!
+    [D][x] homework by (by: 2021-03-03)
+    Now you have 2 tasks in your TaskList.
+
+* #### `event` - Adds Event
+
+  Adds an "event" task to your task list.
+  Event tasks have a description and location. 
+  They are split using a " /at ". Locations do not have to 
+  follow any convention.
+
+
+Example of usage:
+
+    event Party /at Clementi Mall
+
+Expected outcome:
+
+    Got it! I've added this new Task!
+    [E][x] Party (at: Clementi Mall)
+    Now you have 3 tasks in your TaskList.
 
-## Usage
+### Managing the TaskList
 
-### `Keyword` - Describe action
+* #### `list` - lists all the logged tasks
 
-Describe action and its outcome.
+  "List" all tasks from your task list.
 
-Example of usage: 
+Example of usage:
 
-`keyword (optional arguments)`
+    list
 
 Expected outcome:
 
-`outcome`
+    Here are your remainding tasks!
+    1. [T][x] Clean the floor
+    2. [D][x] homework by (by: 2021-03-03)
+    3. [E][x] Party (at: Clementi Mall)
+
+* #### `delete` - Deletes Task
+
+  **Delete** a task from your task list.
+
+Example of usage:
+
+    delete 3
+
+Expected outcome:
+
+    Noted! I have removed this task from the list.
+    [E][x] Party (at: Clementi Mall)
+
+* #### `find` - Finds Tasks
+
+  "Finds" the tasks from your TaskList containing the given keyword.
+  keywords are only compared to the description of each task.
+
+Example of usage:
+
+    find Clean the floor
+
+Expected outcome:
+
+    Here are the relevant tasks:
+    1. [T][x] Clean the floor
+
+* #### `reminder` - reminds you of impending deadline 
+  "reminder" shows a list of all impending deadline tasks in order of
+  days till the deadline.
+
+Example of usage:
+
+    reminder
+
+Expected outcome:
+
+    Here are your upcoming deadline Tasks!
+    1. [D][x] homework by (by: 2021-03-03) x days left!!
+
+
+## Acknowledgement
+
+Reused @banchiang code for GUI implementation.

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Tue Feb 09 17:35:46 SGT 2021
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.2-all.zip
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME