Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Saha9616] iP #371

Open
wants to merge 39 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
556af3f
Add Gradle support
May 24, 2020
4f0dba8
did the level 1 task
Saha9616 Jan 19, 2023
81316d4
did the level 2 task
Saha9616 Jan 20, 2023
ca436b5
did the level 3 task
Saha9616 Jan 21, 2023
4afa0d0
did the level 4 task
Saha9616 Jan 25, 2023
23ceeaf
did automated text ui testing
Saha9616 Jan 28, 2023
8b74572
did error handling
Saha9616 Jan 29, 2023
280dd89
added feature to delete
Saha9616 Jan 29, 2023
347743d
added way to store data
Saha9616 Feb 20, 2023
a23db4d
improved storage
Saha9616 Feb 20, 2023
182c772
merged with level 7
Saha9616 Feb 20, 2023
a387450
made changes to the accepted format of time
Saha9616 Feb 20, 2023
b15e2c2
merged with level 8
Saha9616 Feb 20, 2023
ea355bb
worked on OOP principles
Saha9616 Feb 22, 2023
1ca4046
merging with more OOP
Saha9616 Feb 22, 2023
29fd30c
created packages
Saha9616 Feb 23, 2023
a106830
merge with gradle branch
Saha9616 Feb 23, 2023
449811f
add J-unit testing
Saha9616 Feb 26, 2023
eb60dac
created jar file
Saha9616 Feb 26, 2023
d567558
added java docs
Saha9616 Feb 26, 2023
d7ad960
update java docs
Saha9616 Mar 6, 2023
7d5efaa
Update coding standard
Saha9616 Mar 6, 2023
0eaeda1
Add find feature
Saha9616 Mar 6, 2023
6556b62
Merge branch 'branch-A-CodingStandard'
Saha9616 Mar 6, 2023
7c67085
Fix merge conflict
Saha9616 Mar 6, 2023
c379f16
added javafx
Saha9616 Mar 6, 2023
cac14c4
Merge branch 'branch-JavaFX-Tutorial'
Saha9616 Mar 6, 2023
8e363ce
Update User Guide'
Saha9616 Mar 7, 2023
5476dcc
made some changes
Saha9616 Mar 7, 2023
e990d89
add bcd extension
Saha9616 Mar 7, 2023
9a72ac2
Add assertions
Saha9616 Mar 7, 2023
dcd13e3
Merge branch 'branch-A-Assertions'
Saha9616 Mar 7, 2023
79a2770
Update UG
Saha9616 Mar 7, 2023
e2dcd93
Update Coding Standard
Saha9616 Mar 7, 2023
579e5b8
Update Code Quality
Saha9616 Mar 7, 2023
9400f1e
Merge pull request #2 from Saha9616/branch-A-CodeQuality
Saha9616 Mar 7, 2023
2598518
Make final touch up
Saha9616 Mar 7, 2023
3bb90aa
final changes
Saha9616 Mar 20, 2023
96d046d
Merge branch 'branch-fixes'
Saha9616 Mar 20, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Duke project template
# Duke.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.

Expand All @@ -13,7 +13,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
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:
3. After that, locate the `src/main/java/Duke.Duke.java` file, right-click it, and choose `Run Duke.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
____ _
Expand Down
56 changes: 56 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
plugins {
id 'java'
id 'application'
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.Launcher"
}

shadowJar {
archiveBaseName = "duke"
archiveClassifier = null
}

run{
standardInput = System.in
}
176 changes: 163 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,179 @@
# User Guide
Hello! My name is Thanos, your personal task manager.

## Features
<p align = "left">
<img src= "Ui.png" width = "300">
</p>

### Feature-ABC
## Table of Content
* Quick Start
* Features
* Usage

Description of the feature.
## Quick Start
* Install Java 11 or above is installed in your computer.
* Download the jar file from the repository.
* Copy the file to the preferred location you want to use and run the application.
* You can also try running the application by opening the terminal and typing `java -jar duke.jar`.
* Please press *Enter* after that.

### Feature-XYZ

Description of the feature.
## <a name = "feature"></a>Features
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Add a ToDo task</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Add a Deadline task</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Add an Event task</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Add a period task</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;View a list of your tasks</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Mark task as done</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Mark task as not done</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Delete a task</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Find the task by keyword</a><br>
<input type="checkbox" checked="checked" disabled="disabled">&nbsp;Exit chatbot</a>

## Usage

### `Keyword` - Describe action
### `todo` - Add a ToDo task

Adds a To Do kind of task to your list of tasks.

**Command Format :** todo [task description]

**Example of usage:**

```
todo play video game
> Got it. I've added this task:
> [T][ ] play video game
> Now you have 1 tasks in the list
```
----
### `deadline` - Add a Deadline task

Adds task with deadline.

**Command Format :** deadline [task desc] /by [yyyy-mm-dd]

**Example of usage:**

```
deadline go on a date /by 2019-10-15
> [D][ ] go on a date Oct 15 2019
> Now you have 2 tasks in the list
```
----
### `event` - Add an Event task

Adds an Event task to your task manager.

**Command Format :** event [task desc] /from [yyyy-mm-dd] /to [yyyy-mm-dd]

**Example of usage:**

```
event wedding /from 2023-09-12 /to 2023-10-12
> [E][ ] wedding Sep 12 2023-Oct 12 2023
> Now you have 3 tasks in the list

```
----
### `periodTask` - Add a period task

Adds a period task to your task manager.

**Command Format :** periodTask [task desc] /between [yyyy-mm-dd] /and [yyyy-mm-dd]

**Example of usage:**

```
periodTask submit book /between 2023-09-12 /and 2023-10-12
> [E][ ] submit book Sep 12 2023-Oct 12 2023
> Now you have 3 tasks in the list

```
----
### `list` - View a list of your tasks

Shows the list of all tasks.

**Command Format :** list

**Example of usage:**

Describe the action and its outcome.
```
list
> 1.[D][ ] go on a date Oct 15 2019
> 2.[E][ ] wedding Sep 12 2023-Oct 12 2023

```
----
### `mark` - Mark task as done

Marks the task as done.

**Command Format :** mark [index]

**Example of usage:**

```
mark 1
> Nice! I've marked this task as done:
> [T][X] eat
```
----
### `unmark` - Mark task as not done

Marks the task as not done by replacing "X" sign with " ".

**Command Format :** unmark [index]

**Example of usage:**

```
unmark 1
> OK, I've marked this task as not done yet:
> [T][ ] eat
```
----
### `delete` - Delete a task

Example of usage:
Removes the task from the task manager.

`keyword (optional arguments)`
**Command Format :** delete [index]

Expected outcome:
**Example of usage:**

Description of the outcome.
```
delete 1
> Noted. I've removed this task:
> [T][ ] eat
> Now you have 2 tasks in the list

```
----
### `find` - Find the task by keyword

Finds the tasks with the specified keyword.

**Command Format :** find [keyword]

**Example of usage:**

```
expected output
find eat
> 1.[E][ ] eat

```
----
### `bye` - Exit chatbot

Closes the application.

**Command Format :** bye

**Example of usage:**

```
bye
> Bye mortal, I will get back to destroying galaxies
```


Binary file added docs/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -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
Loading