nus-cs2103-AY1920S1 · shawnlsj97 · Aug 6, 2019 · Aug 12, 2019 · Aug 18, 2019 · Aug 18, 2019
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1 @@
+language: java
diff --git a/Development README.md b/Development README.md
@@ -0,0 +1,39 @@
+# Setting up
+
+**Prerequisites**
+
+* JDK 11
+* Recommended: IntelliJ IDE
+* Fork this repo to your GitHub account and clone the fork to your computer
+
+**Importing the project into IntelliJ**
+
+1. Open IntelliJ (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project dialog first).
+1. Set up the correct JDK version.
+   * Click `Configure` > `Structure for new Projects` (in older versions of Intellij:`Configure` > `Project Defaults` > `Project Structure`).
+   * If JDK 11 is listed in the drop down, select it. If it is not, click `New...` and select the directory where you installed JDK 11.
+   * Click `OK`.
+1. Click `Import Project`.
+1. Locate the project directory and click `OK`.
+1. Select `Create project from existing sources` and click `Next`.
+1. Rename the project if you want. Click `Next`.
+1. Ensure that your src folder is checked. Keep clicking `Next`.
+1. Click `Finish`.
+
+# Tutorials 
+
+Duke Increment | Tutorial
+---------------|---------------
+`A-Gradle` | [Gradle Tutorial](tutorials/gradleTutorial.md)
+`A-TextUiTesting` | [Text UI Testing Tutorial](tutorials/textUiTestingTutorial.md)
+`Level-10` | JavaFX tutorials:<br>→ [Part 1: Introduction to JavaFX][fx1]<br>→ [Part 2: Creating a GUI for Duke][fx2]<br>→ [Part 3: Interacting with the user][fx3]<br>→ [Part 4: Introduction to FXML][fx4]
+
+[fx1]: <tutorials/javaFxTutorialPart1.md>
+[fx2]: <tutorials/javaFxTutorialPart2.md>
+[fx3]: <tutorials/javaFxTutorialPart3.md>
+[fx4]: <tutorials/javaFxTutorialPart4.md>
+
+# Feedback, Bug Reports
+
+* If you have feedback or bug reports, please post in [se-edu/duke issue tracker](https://github.com/se-edu/duke/issues).
+* We welcome pull requests too.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Shawn Lee Shi Jie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,39 +1,201 @@
-# Setting up
+# Trackr
 
-**Prerequisites**
+Trackr is a **desktop application that helps you to manage tasks**. Trackr is **optimized for users who prefer to work with a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI).
 
-* JDK 11
-* Recommended: IntelliJ IDE
-* Fork this repo to your GitHub account and clone the fork to your computer
+<img src="./READMEMedia/media/app.png" width="254" height="400" />
 
-**Importing the project into IntelliJ**
+If you can type fast, Trackr can help you complete your task management process faster than traditional GUI apps.
 
-1. Open IntelliJ (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project dialog first).
-1. Set up the correct JDK version.
-   * Click `Configure` > `Structure for new Projects` (in older versions of Intellij:`Configure` > `Project Defaults` > `Project Structure`).
-   * If JDK 11 is listed in the drop down, select it. If it is not, click `New...` and select the directory where you installed JDK 11.
-   * Click `OK`.
-1. Click `Import Project`.
-1. Locate the project directory and click `OK`.
-1. Select `Create project from existing sources` and click `Next`.
-1. Rename the project if you want. Click `Next`.
-1. Ensure that your src folder is checked. Keep clicking `Next`.
-1. Click `Finish`.
+### 1. Quick Start
+1. Ensure you have Java `11` or above installed in your computer.
+2. Download the latest `trackr.jar` [here](https://github.com/shawnlsj97/duke/releases/tag/v1.0).
+3. Copy the file to the folder you want to use as the home folder for your list of tasks.
+4. Double-click the file to start to app. The GUI should appear shortly.
+<img src="./READMEMedia/media/launch.png" width="254" height="400" />
 
-# Tutorials 
+5. Type all commands in the command box at the bottom and press "Enter" on your keyboard to execute it.
+e.g. typing `help` and pressing "Enter" will show a list of available commands.
+    * Some example commands you can try:
+        * `list`: lists all tasks
+        * `todo 100 pushups`: adds a task to be done called `100 pushups` to the task list
+        * `delete 1`: deletes the 1st task shown in the list
+        * `exit`: exits the app
+        * Refer to the section below for details of available commands in this application
 
-Duke Increment | Tutorial
----------------|---------------
-`A-Gradle` | [Gradle Tutorial](tutorials/gradleTutorial.md)
-`A-TextUiTesting` | [Text UI Testing Tutorial](tutorials/textUiTestingTutorial.md)
-`Level-10` | JavaFX tutorials:<br>→ [Part 1: Introduction to JavaFX][fx1]<br>→ [Part 2: Creating a GUI for Duke][fx2]<br>→ [Part 3: Interacting with the user][fx3]<br>→ [Part 4: Introduction to FXML][fx4]
+### 2. Features
 
-[fx1]: <tutorials/javaFxTutorialPart1.md>
-[fx2]: <tutorials/javaFxTutorialPart2.md>
-[fx3]: <tutorials/javaFxTutorialPart3.md>
-[fx4]: <tutorials/javaFxTutorialPart4.md>
+Words in `UPPER_CASE` are the parameters to be supplied by the user e.g. in `todo TASK_NAME'`, `TASK_NAME` is a parameter which can be used as `todo gym workout`.
 
-# Feedback, Bug Reports
+#### 2.1 Viewing help: `help`
+Displays all available commands in the application.
 
-* If you have feedback or bug reports, please post in [se-edu/duke issue tracker](https://github.com/se-edu/duke/issues).
-* We welcome pull requests too.
+Format: `help`
+
+#### 2.2 Adding a task to be done: `todo` (alias `t`)
+Adds a task to be done with the provided `TASK_NAME` to your list.
+
+Format: `todo TASK_NAME` or `t TASK_NAME`
+
+Examples: 
+* `todo 100 pushups`
+* `t 100 pushups`
+
+    Adds a task to be done with the name `100 pushups` to your list of tasks.
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/todo.PNG" width="254" height="108" />
+
+#### 2.3 Adding a deadline: `deadline` (alias `d`)
+Adds a deadline with the provided `DEADLINE_NAME` and date and time in the format `DD/MM/YYYY HHMM` to your list.
+
+Format: `deadline DEADLINE_NAME /by DD/MM/YYYY HHMM` or `d DEADLINE_NAME /by DD/MM/YYYY HHMM`
+
+Examples: 
+* `deadline math assignment /by 30/11/2019 2359`
+* `d math assignment /by 30/11/2019 2359`
+
+    Adds a deadline with the name `math assignment` to be completed by `30/11/2019 2359` to your list.
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/deadline.PNG" width="254" height="109" />
+
+#### 2.4 Adding an event to be attended: `event` (alias `e`)
+Adds an event with the provided `EVENT_NAME` and date and time in the format `DD/MM/YYYY HHMM` to your list.
+
+Format: `event EVENT_NAME /at DD/MM/YYYY HHMM` or `e EVENT_NAME /at DD/MM/YYYY HHMM`
+
+Examples: 
+* `event birthday party /at 28/10/2019 1930`
+* `e birthday party /at 28/10/2019 1930`
+
+    Adds an event with the name `birthday party` to be attended on `28/10/2019 1930` to your list.
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/event.PNG" width="254" height="110" />
+
+#### 2.5 Listing all tasks: `list` (alias `l`)
+Shows all tasks in your list.
+
+Format: `list` or `l`
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/list.PNG" width="254" height="129" />
+
+#### 2.6 Updating name of task in your list: `update` (alias `u`)
+Updates name of specified (using `INDEX`) task in your list to `NEW_TASK_NAME`.
+
+Format: `update INDEX NEW_TASK_NAME` or `u INDEX NEW_TASK_NAME`
+
+Examples: 
+* `update 1 50 situps`
+* `u 1 50 situps`
+
+    Updates the name of the task in position `1` to `50 situps`.
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/update.PNG" width="254" height="112" />
+
+#### 2.7 Retrieving tasks by name: `find` (alias `f`)
+Finds tasks whose names contain any of the given `KEYWORD`. You may input multiple keywords.
+
+Format: `find KEYWORD` or `f KEYWORD`
+
+Examples: 
+* `find assignment`
+* `f assignment`
+
+    Retrieves tasks containing the word `assignment` in their name.
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/find.PNG" width="254" height="106" />
+
+#### 2.8 Marking a task as completed: `complete` (alias `c`)
+Marks specified (using `INDEX`) task on the list as completed.
+
+Format: `complete INDEX` or `c INDEX`
+
+Examples: 
+* `complete 1`
+* `c 1`
+
+    Marks the task in position `1` as completed.
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/complete.PNG" width="254" height="109" />
+
+#### 2.9 Removing a task: `remove` (alias `r`)
+Remove specified task from the list.
+
+Format: `remove INDEX` or `r INDEX`
+
+Examples: 
+* `remove 1`
+* `r 1`
+
+    Removes the task in position `1` from the list.
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/remove.PNG" width="254" height="113" />
+
+#### 2.10 Undoing previous command: `undo`
+Undo previous command and revert changes to the list of tasks.
+
+Format: `undo`
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/undo.PNG" width="254" height="113" />
+
+#### 2.11 Display input history: `history`
+Display all input you made into the application during the current session.
+
+Format: `history`
+
+Expected Outcome:
+
+<img src="./READMEMedia/media/history.PNG" width="254" height="148" />
+
+#### 2.12 Exiting the application: `exit`
+Exits the program.
+
+Format: `exit`
+
+#### 2.13 Saving data
+Task list data is saved in the hard disk automatically after any command that changes the data.
+There is no need to save manually.
+
+### 3. FAQ
+*Q*: How can I transfer my task list to a new computer?
+*A*: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Trackr folder.
+
+### 4. Feedback, Bug Reports
+
+* If you have feedback or bug reports, please post in [shawnlsj97/duke issue tracker](https://github.com/shawnlsj97/duke/issues).
+* We welcome pull requests too.
+
+### 5. License
+Trackr is [MIT-licensed](https://github.com/shawnlsj97/duke/blob/master/LICENSE).
+
+
+### 6. Command Summary
+* **Add**
+    * **Todo**: `todo TASK_NAME`
+    * **Deadline**: `deadline DEADLINE_NAME /by DD/MM/YYYY HHMM`
+    * **Event**: `event EVENT_NAME /at DD/MM/YYYY HHMM`
+* **Update**: `update INDEX NEW_TASK_NAME`
+* **List**: `list`
+* **Find**: `find KEYWORD`
+* **Complete**: `complete INDEX`
+* **Remove**: `remove INDEX`
+* **Undo**: `undo`
+* **History**: `history`
+* **Help**: `help`
+* **Exit**: `exit`
diff --git a/READMEMedia/media/app.png b/READMEMedia/media/app.png
diff --git a/READMEMedia/media/complete.PNG b/READMEMedia/media/complete.PNG
diff --git a/READMEMedia/media/deadline.PNG b/READMEMedia/media/deadline.PNG
diff --git a/READMEMedia/media/event.PNG b/READMEMedia/media/event.PNG
diff --git a/READMEMedia/media/find.PNG b/READMEMedia/media/find.PNG
diff --git a/READMEMedia/media/history.PNG b/READMEMedia/media/history.PNG
diff --git a/READMEMedia/media/launch.png b/READMEMedia/media/launch.png
diff --git a/READMEMedia/media/list.PNG b/READMEMedia/media/list.PNG
diff --git a/READMEMedia/media/remove.PNG b/READMEMedia/media/remove.PNG
diff --git a/READMEMedia/media/todo.PNG b/READMEMedia/media/todo.PNG
diff --git a/READMEMedia/media/undo.PNG b/READMEMedia/media/undo.PNG
diff --git a/READMEMedia/media/update.PNG b/READMEMedia/media/update.PNG
diff --git a/build.gradle b/build.gradle
@@ -0,0 +1,66 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'org.openjfx.javafxplugin' version '0.0.7'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+}
+
+group 'seedu.duke'
+version '0.1.0'
+
+repositories {
+    mavenCentral()
+}
+
+javafx {
+    version = "11.0.2"
+    modules = [ 'javafx.controls', 'javafx.fxml' ]
+}
+
+shadowJar {
+    archiveBaseName = "trackr"
+    archiveVersion = "1.0"
+    archiveClassifier = null
+    archiveAppendix = null
+}
+
+application {
+    // Change this to your main class.
+    mainClassName = "Launcher"
+}
+
+run {
+    standardInput = System.in
+}
+
+dependencies {
+    testImplementation 'org.junit.jupiter:junit-jupiter: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'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'linux'
+}
+
+test {
+    useJUnitPlatform()
+}
+
+checkstyle {
+    toolVersion = '8.23'
+}
diff --git a/cd b/cd