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

[Banerjee Aditya] iP #354

Open
wants to merge 47 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
b5b3de5
Add Level 1 to 6
adidoesnt Jan 21, 2021
c5243be
Added levels 7 to 9.
adidoesnt Feb 4, 2021
91467aa
Added jar file.
adidoesnt Feb 4, 2021
8483eb7
Add gradle support
adidoesnt Feb 9, 2021
fc8799a
Add GUI.
adidoesnt Feb 9, 2021
487b795
insert new files for GUI
adidoesnt Feb 14, 2021
52bbd3b
Merging branch to fix unrelated history issue.
adidoesnt Feb 14, 2021
9012417
add duke cache and daemon extra files
adidoesnt Feb 14, 2021
92edff3
update branch level 7
adidoesnt Feb 14, 2021
34a4de0
Merge pull request #1 from adidoesnt/branch-Level-7
adidoesnt Feb 14, 2021
84c0ca9
add log daemon file
adidoesnt Feb 14, 2021
f119e34
Merge pull request #2 from adidoesnt/branch-Level-7
adidoesnt Feb 14, 2021
9f128dd
Fix Parser code quality violation
adidoesnt Feb 14, 2021
1d5b6c8
Merge pull request #3 from adidoesnt/branch-Level-8
adidoesnt Feb 14, 2021
d3abeaa
Edit JavaDoc comments
adidoesnt Feb 14, 2021
2e20ad2
Merge pull request #4 from adidoesnt/branch-A-JavaDoc
adidoesnt Feb 14, 2021
dc5cd55
Edit find method
adidoesnt Feb 14, 2021
ec2b440
Merge pull request #5 from adidoesnt/branch-Level-9
adidoesnt Feb 14, 2021
a3a5705
Edit GUI greeting
adidoesnt Feb 14, 2021
629fbe3
Merge pull request #6 from adidoesnt/branch-Level-10
adidoesnt Feb 14, 2021
608148c
Fix coding standard issues
adidoesnt Feb 14, 2021
ffdbad8
Merge pull request #7 from adidoesnt/branch-A-CodingStandard
adidoesnt Feb 14, 2021
4a423cc
Add assertions
adidoesnt Feb 16, 2021
361614d
Merge pull request #8 from adidoesnt/A-Assertions
adidoesnt Feb 16, 2021
40e19e9
Fix code quality and storage issues
adidoesnt Feb 16, 2021
6376306
Merge pull request #9 from adidoesnt/A-CodeQuality
adidoesnt Feb 16, 2021
50a49f0
Add extension to detect duplicates
adidoesnt Feb 16, 2021
22c1d5a
Fix bugs
adidoesnt Feb 16, 2021
71234dd
Merge pull request #10 from adidoesnt/C-DetectDuplicates
adidoesnt Feb 16, 2021
1d02cc5
Added user guide
adidoesnt Feb 16, 2021
5edaf6f
Merge pull request #11 from adidoesnt/A-UserGuide
adidoesnt Feb 16, 2021
c6f006b
Delete UI.png
adidoesnt Feb 16, 2021
c30238f
Added Ui.png
adidoesnt Feb 16, 2021
e689175
Set theme jekyll-theme-minimal
adidoesnt Feb 16, 2021
6577dad
Update README.md
adidoesnt Feb 16, 2021
b216734
Update README.md
adidoesnt Feb 16, 2021
c413362
Update README.md
adidoesnt Feb 16, 2021
01685fa
Update README.md
adidoesnt Feb 16, 2021
3ece64f
Update README.md
adidoesnt Feb 16, 2021
22c5efb
Update README.md
adidoesnt Feb 16, 2021
36f3839
Update README.md
adidoesnt Feb 16, 2021
5c40353
Update README.md
adidoesnt Feb 19, 2021
f80a598
Fix issues with previous jar
adidoesnt Mar 19, 2021
22ea480
Merge pull request #13 from adidoesnt/A-Improvements
adidoesnt Mar 19, 2021
4e63da1
Change user guide and help
adidoesnt Mar 19, 2021
bc65610
Change user guide
adidoesnt Mar 19, 2021
7fcff7a
Merge pull request #14 from adidoesnt/A-Improvements
adidoesnt Mar 19, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-minimal
53 changes: 53 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
plugins {
id 'java'
id 'application'
id "com.github.johnrengelman.shadow" version "6.1.0"
id 'checkstyle'
}

repositories {
mavenCentral()
jcenter()
google()
maven {
url "https://maven.springframework.org/release"
}
maven {
url "https://maven.restlet.com"
}
}

dependencies {
implementation 'org.jetbrains:annotations:20.1.0'
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.6.0'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
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'
}

application {
mainClassName = "duke.Launcher"
}

test {
useJUnitPlatform()
}

checkstyle {
toolVersion = '8.29'
}

run {
enableAssertions = true
}
165 changes: 154 additions & 11 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,163 @@
# User Guide
# User Guide - Features

## Features
## UI Sample
![image](Ui.png)
<br>

### Feature 1
Description of feature.
## `ToDo`

## Usage
### Usage
`todo` *Description of Task*

### `Keyword` - Describe action
### Action
Adds a new task of type "ToDo" to the task list.

Describe action and its outcome.
### Example of usage:
`todo` *buy groceries*

Example of usage:
### Expected outcome:
Added Task!

`keyword (optional arguments)`
## `Deadline`

Expected outcome:
### Usage
`deadline` *Description of Task*/by *DD.MM.YYYY HH:MM*

`outcome`
### Action
Adds a new task of type "Deadline" to the task list.

### Example of usage:
`deadline` *return library book*/by *14.02.2021 14:00*

### Expected outcome:
Added Task!

## `Event`

### Usage
`event` *Description of Task*/from *DD.MM.YYYY HH:MM* to *DD.MM.YYYY HH:MM*

### Action
Adds a new task of type "Event" to the task list.

### Example of usage:
`event` *Marcus's birthday party*/from *14.02.2021 18:00* to *14.02.2021 23:30*

### Expected outcome:
Added Task!

## `List`

### Usage
`list`

### Action
Lists all tasks currently in the task list.

### Example of usage:
`list`

### Expected outcome:
All Tasks:
[T][] buy groceries
[D][] deadline return library book/by Sun Feb 14 14:00:00 SGT 2021
[E][] Marcus's birthday party/from Sun Feb 14 18:00:00 SGT 2021 to Sun Feb 14 23:30:00 SGT 2021

## `Complete`

### Usage
`complete` *Task Type* *Task Description*

### Action
Finds and marks the desired task complete.

### Example of usage:
`complete` *todo buy groceries*
`complete` *deadline* *return library book/by 14.02.2021 14:00*
`complete` *event* *Marcus's birthday party/from 14.02.2021 18:00 to 14.02.2021 23:30*

### Expected outcome:
Task marked complete!

## `Remove`

### Usage
`remove` *Task Type* *Task Description*

### Action
Finds and removes the desired task from the task list.

### Example of usage:
`remove` *todo buy groceries*
`remove` *deadline* *return library book/by 14.02.2021 14:00*
`remove` *event* *Marcus's birthday party/from 14.02.2021 18:00 to 14.02.2021 23:30*

### Expected outcome:
Task removed.

## `Find`

### Usage
`find` *Key Word*

### Action
Finds and lists all tasks from the task list that contain the entered key word.

### Example of usage:
`find` *book*

### Expected outcome:
There were 1 tasks containing your keyword:
1: [D][] deadline return library book/by Sun Feb 14 14:00:00 SGT 2021

## `Help`

### Usage
`help`

### Action
Lists all commandss accepted by Duke

### Example of usage:
`help`

### Expected outcome:
Enter one of the following commands:
[1] Hello
[2] Todo <Description of Task>
[3] Deadline <Description of Task>/by <DD.MM.YYYY HH:MM>
[4] Event <Description of Task>/from <DD.MM.YYYY HH:MM> to <DD.MM.YYYY HH:MM>
[5] List
[6] Find <Key Word>
[7] Complete <Task Type> <Description>
[8] Remove <Task Type> <Description>
[9] Help
[10] Bye

## `Hello`

### Usage
`hello`

### Action
If entered upon launch, prompts a greeting and an instruction from Duke. Subsequently prompts an instruction from Duke only.

### Example of usage:
`hello`

### Expected outcome:
Please enter a command.

## `Bye`

### Usage
`bye`

### Action
Exits the application.

### Example of usage:
`bye`

### Expected outcome:
Closure of application.
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.7-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading