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

[Pragya] iP #415

Open
wants to merge 33 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
d839859
Add Gradle support
May 24, 2020
7fa8c8b
Level-1
prgJ Feb 8, 2022
c305ba1
Level 2 - Add, List
prgJ Feb 21, 2022
66b94bc
Level 3 - mark as done (and undone)
prgJ Feb 21, 2022
f5502b6
Level 4
prgJ Feb 21, 2022
bf3382e
invalid commands
prgJ Feb 21, 2022
9ca2fb9
delete functionality
prgJ Feb 21, 2022
94c1074
date/time
prgJ Feb 21, 2022
350533a
Revert "date/time"
prgJ Feb 21, 2022
b505b8f
saving functionality
prgJ Feb 21, 2022
245dbb5
bug fixes
prgJ Feb 21, 2022
d86c425
Date-time
prgJ Feb 21, 2022
bde50ba
Merge branch 'branch-Level-7' into branch-Level-8
prgJ Feb 21, 2022
8e17e86
fix merge issues
prgJ Feb 21, 2022
c50eb0f
more oop in progress - function splitting
prgJ Feb 23, 2022
df7726a
Adding more oop to Duke
prgJ Feb 26, 2022
b31734b
Make Duke Packages
prgJ Feb 26, 2022
2055aad
1. implement level-9 Find command
prgJ Feb 26, 2022
722ba5a
Added Javadoc comments
prgJ Feb 26, 2022
9afc961
1. Added JavaDoc comments
prgJ Feb 26, 2022
fc14d28
1. Edited code to comply with CodingStandard
prgJ Feb 26, 2022
02ce442
Merge branch 'branch-A-JavaDoc'
prgJ Feb 26, 2022
dd38087
Merge branch 'branch-A-CodingStandard'
prgJ Feb 26, 2022
1205e00
Merge commit 'd8398594b7bc43da5eb865321c5a50cec4b3923d'
prgJ Feb 26, 2022
fc16496
Implement Stats command
prgJ Feb 26, 2022
626b5c2
Changes made to code quality
prgJ Feb 26, 2022
f6cffc7
Merge pull request #2 from prgJ/branch-A-CodeQuality
prgJ Feb 26, 2022
8edaff3
Set theme jekyll-theme-architect
prgJ Feb 26, 2022
1513032
Updated UserGuide
prgJ Feb 26, 2022
665ac9c
Merge branch 'master' of ssh://github.com/prgJ/ip
prgJ Feb 26, 2022
5a274ba
add gui
prgJ Apr 3, 2022
b83ac50
clean up code
prgJ Apr 3, 2022
ac62924
no message
prgJ Apr 4, 2022
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
63 changes: 63 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
plugins {
id 'java'
id 'application'
id 'checkstyle'
id 'com.github.johnrengelman.shadow' version '5.1.0'
id 'org.openjfx.javafxplugin' version '0.0.10'
}

javafx {
version = "11.0.2"
modules = [ 'javafx.controls' ]
}

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'
}
test {
useJUnitPlatform()

testLogging {
events "passed", "skipped", "failed"

showExceptions true
exceptionFormat "full"
showCauses true
showStackTraces true
showStandardStreams = false
}
}

application {
mainClassName = "seedu.duke.Duke"
}

shadowJar {
archiveBaseName = "duke"
archiveClassifier = null
}

checkstyle {
toolVersion = '8.29'
}

run{
standardInput = System.in
}
11 changes: 11 additions & 0 deletions data/duke.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
D | 1 | clean | 20-02-2022 1500 | 21-02-2022 1500
T | 0 | read | 22-02-2022 1600
T | 1 | run errands | 16-02-2022 1800
T | 0 | run somewhere | 24-02-2022 1600
E | 0 | party | 10-01-2022 1200 | 10-01-2022 1200 | 10-01-2022 1400
E | 0 | congress | 23-01-2022 1200 | 10-01-2022 1200 | 10-01-2022 1400
E | 0 | war | 26-02-2022 1200 | 10-01-2022 1200 | 10-01-2022 1400
D | 1 | homework | 19-02-2022 1500 | 21-02-2022 1500
D | 1 | App Project | 21-02-2022 1200 | 21-02-2022 1500
D | 1 | Web project | 25-02-2022 1500 | 26-02-2022 1500
T | 0 | call | 03-04-2022 1552
132 changes: 119 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,135 @@
# User Guide
# User Guide for Duke

## Features

### Feature-ABC
### List - `list`

Description of the feature.
Lists all available tasks saved.

### Feature-XYZ
**Usage**:

Description of the feature.
`list`

## Usage
```
returns a list of all tasks. eg

List:
1. T | [X] Run

```

### `Keyword` - Describe action
### Tasks

Describe the action and its outcome.
Duke accepts various types of tasks! These include

Example of usage:
#### Todo - `todo`
* A Todo task is a task with no given date or deadline...its just something to do.

`keyword (optional arguments)`
**Usage**:

Expected outcome:
`todo [task description]`

Description of the outcome.
```
creates a todo task. Eg:
T | [ ] Run

```
expected output

#### Event - `event`
* Event tasks are tasks that are associated with a specific day or time.

**Usage**:

`event [task description] [/at] [dd-MM-yyyy HHmm]_to_[dd-MM-yyyy HHmm]`

```
creates an event task. Eg:
E | [ ] Run (at: 31-01-2022 1800 to 31-01-2022 21000)

```

#### Deadline - `deadline`
* Deadline tasks are tasks that need to be completed by a certain date or time.

**Usage**:

`deadline [task description] [/by] [dd-MM-yyyy HHmm]`

```
creates a deadline task. Eg:
D | [ ] Run (by: 24-04-2022 1400)

```


### Mark and Unmark - `mark` and `unmark`

Mark and Unmark allows users to moniter task completeness.

**Usage**:

`mark [task index]`

```
Marks a task as complete. Eg:
T | [X] Run

```

`unmark [task index]`

```
Marks a task as incomplete. Eg:
T | [ ] Run

```

### Find - `find`

Find allows users to narrow the search for a task by their specified keyword.

**Usage**:

`find [task description]`

```
Finds tasks containing the specified task description. Eg:
'find run' returns

List:
1. T | [X] run
2. T | [ ] run errands
3. T | [ ] run away

```

### Statistics - `stats`

Statistics allow users to see their completed tasks over a given period of time.

`stats [day index]`

```
Lists tasks completed [day index] days before the current day. Eg:
'stats 7' returns all the tasks completed in the past 7 days.

List:
1. T | [X] run

```

### Delete - `delete`

Delete allows users to delete tasks.

`delete [task index]`

```
Deletes selected task index. Eg:
'delete 1' deletes the first task

List:
1. T | [ ] run errands
2. T | [ ] run away

```
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-architect
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