[Wang Guanlin] iP

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+*.class
+/data/duke.txt

README.md

@@ -1,24 +1,31 @@
-# Duke project template
+# Duke v0.9.0
+> *"Be not afraid of growing slowly, be afraid of standing still."* - Chinese proverb
 
-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.
+Duke offers you a:
+- Hassle free
+- Text based
+- Minimalist
+and completely **offline** experience of planning your tasks!
 
-## Setting up in Intellij
+## Duke's features
+- [x] Adding and saving tasks
+- [ ] GUI (coming soon!)
+- [ ] Mystery features 😜
 
-Prerequisites: JDK 11, update Intellij to the most recent version.
+## Setting up Duke
+1. Download it [here](https://github.com/WangGLJoseph/ip/releases/download/A-Jar/ip.jar)
+2. Double-click to run it
+3. Add your tasks
+4. Enjoy **mastery** over your tasks 😆
 
-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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
+A snippet of the workings of controlling your tasks. Behold, you've got the power!
+   ```java
+    public String finishTask(int index) throws DukeException {
+        if (index > taskArrayList.size()) {
+            throw new DukeException("This task index is not in the task list!");
+        }
+        taskArrayList.get(index - 1).markAsDone();
+        return (sandwich("Congratulations! You have finished this task: "
+                + taskArrayList.get(index - 1).toString()));
+    }
    ```

build.gradle

@@ -0,0 +1,60 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    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'
+    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'
+}
+
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+        showStandardStreams = false
+    }
+}
+
+application {
+    mainClassName = "cs2103.duke.Duke"
+}
+
+shadowJar {
+    archiveBaseName = "duke"
+    archiveClassifier = null
+}
+
+checkstyle {
+    toolVersion = '8.29'
+}
+
+run {
+    standardInput = System.in
+}

docs/README.md

@@ -1,24 +1,93 @@
-# User Guide
+# User Guide for Duke
 
 ## Features 
 
-### Feature-ABC
+### Adding tasks
 
-Description of the feature.
+Duke allows you to add 3 types of tasks:
+- Todo
+- Deadline
+- Event
 
-### Feature-XYZ
+### Saving tasks
 
-Description of the feature.
+Duke saves your tasks automatically when you exit the program.
 
-## Usage
+### Deleting tasks
+
+Duke lets you delete any task from your task list.
+
+### Finishing tasks
+
+Duke lets you mark any task on your task list as complete, without deleting them.
+
+### Undoing previous command
+
+Duke lets you undo your last undo-able command, say goodbye to accidentally deleting a task!
 
-### `Keyword` - Describe action
+### List tasks on your task list
 
-Describe the action and its outcome.
+Duke lets you see everything on your task list at a glance.
+
+
+## Usage
+
+### `todo` - Adds a todo task
 
 Example of usage: 
 
-`keyword (optional arguments)`
+`todo nap`
+
+Expected outcome:
+
+The todo task 'nap' will be added to your task list.
+
+```
+New todo task added:
+[T][ ] nap
+You now have x item(s) in your task list.
+```
+
+
+### `deadline` - Adds a deadline task
+
+Example of usage:
+
+`ip due /by 2021-09-20`
+
+Expected outcome:
+
+The deadline task 'ip due' will be added to your task list.
+
+```
+New deadline task added:
+[D][ ] ip due (by: 2021 09 20)
+You now have x item(s) in your task list.
+```
+
+
+### `event` - Adds an event task
+
+Example of usage:
+
+`event family meal /at 2021-09-21`
+
+Expected outcome:
+
+The event task 'family meal' will be added to your task list.
+
+```
+New event task added:
+[E][ ] family meal (by: 2021 09 21)
+You now have x item(s) in your task list.
+```
+
+
+### `bye` - Saves tasks and exits the program
+
+Example of usage:
+
+`bye`
 
 Expected outcome:
 
@@ -27,3 +96,80 @@ Description of the outcome.
 ```
 expected output
 ```
+
+
+### `delete` - Deletes a task from your task list
+
+Deletes the task at the indicated index.
+
+Example of usage:
+
+`delete 3`
+
+Expected outcome:
+
+Description of the outcome.
+
+```
+1.[T][ ] nap
+2.[D][ ] ip submit (by: 2021 09 20)
+```
+
+
+### `done` - Marks a task as done
+
+Marks the task at the indicated index as done with an 'X'.
+
+Example of usage:
+
+`done 1`
+
+Expected outcome:
+
+The task at the indicated index will be marked as done.
+
+```
+Congratulations! You have finished this task:
+[T][X] nap
+```
+
+
+### `undo` - Undoes the last command
+
+Undoes the last valid undo-able command.
+
+Example of usage:
+
+`undo`
+
+Expected outcome:
+
+The previous command's effect will be reverted.
+
+```
+I undid your previous command:
+done 1
+Here is your current task list:
+1.[T][ ] nap
+2.[D][ ] ip due (by: 2021 09 20)
+3.[E][ ] family meal (at: 2021 09 21)
+```
+
+
+### `list` - Lists all tasks in the task list.
+
+Returns all the tasks in the task list
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+A list of all the tasks on your task list.
+
+```
+1.[T][ ] nap
+2.[D][ ] ip due (by: 2021 09 20)
+3.[E][ ] family meal (at: 2021 09 21)
+```

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-time-machine

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.2-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists