Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
125 commits
Select commit Hold shift + click to select a range
f0ac11a
add: .gitignore
Jan 20, 2022
2c93817
add: Siri/Level1.java
Jan 20, 2022
704e5b3
add javadocs comments
Jan 21, 2022
5068ebc
add Siri/Level2
Jan 21, 2022
38fcffd
update Siri/Level2
Jan 21, 2022
87d0d71
add: Level1.java
Jan 20, 2022
7b81057
add javadocs comments
Jan 21, 2022
3d16555
add Level2.java
Jan 21, 2022
2770cef
update Level2.java
Jan 21, 2022
12ba4e1
add Level3.java
Jan 21, 2022
dff1c86
neaten 1 line of code in Level2.java
Jan 21, 2022
0b68584
add Level3.java
Jan 21, 2022
a0a2092
Shift Level3.java to L3 folder
Jan 21, 2022
d152a84
add Task.java
Jan 21, 2022
a5cd7ea
update Level3.java
Jan 21, 2022
4288d48
Revert "update Level3.java"
Jan 21, 2022
f782ffb
Revert "Revert "update Level3.java""
Jan 21, 2022
37ab3af
add mark logic to Level3.java
Jan 21, 2022
ee2396d
add markAsNotDone method to Task.java
Jan 21, 2022
0d0be9c
update Level3.java
Jan 21, 2022
e45bca6
add javadoc comments to Level3.java
Jan 21, 2022
0a90fee
update Siri replies to mark and unmark user inputs
Jan 21, 2022
8ac0e8b
condense multiple system.out.println into lesser lines in Level3.java
Jan 21, 2022
05cbe45
Merge commit '38fcffd337170938ce966b3fd4cdb031fb1fb05a'
Jan 24, 2022
00f7fcf
move level1.java into L1 folder
Jan 26, 2022
432b9a4
move Level2.java into L2 folder
Jan 26, 2022
89a002f
add Level4.java into L4 folder
Jan 26, 2022
ab7e094
add Task.java to L4 folder
Jan 26, 2022
707ee94
add Todo.java to L4 folder
Jan 26, 2022
116e09e
add @Override tag in line 24 of Task.java
Jan 26, 2022
4c07809
update Todo.java
Jan 26, 2022
1fe0728
update Level4.java
Jan 26, 2022
3fc747d
add Deadline.java to L4 folder
Jan 26, 2022
1e6b55a
update Deadline.java
Jan 26, 2022
b7faffc
update Level4.java to accept deadline and todo tasks
Jan 26, 2022
bc69135
add javadoc comment to line 51
Jan 26, 2022
a584d1b
update Todo.java toString method
Jan 26, 2022
0b735ca
update Deadline.java toString method
Jan 26, 2022
716fed4
add Event.java to L4 folder
Jan 26, 2022
511d9cc
update Level4.java string outputs for todo, deadline and event tasks
Jan 26, 2022
a425c4f
update input.txt
Jan 26, 2022
0c6eb74
update runtest.sh to include path to main class on line 16
Jan 26, 2022
6966e73
update Level4.java removed final else condition
Jan 26, 2022
9052665
Move Deadline.java to L5 folder
Jan 28, 2022
401156d
Move Task.java to L5 folder
Jan 28, 2022
d36f543
Move Todo.java to L5 folder
Jan 28, 2022
2dbff74
Move Event.java to L5 folder
Jan 28, 2022
d6a00f5
add EmptyDescException.java
Jan 28, 2022
741d2b3
Level5.java: update elseif condition for "todo" to handle exception
Jan 28, 2022
b72cae3
Level5.java: Update if condition to identify whitespaces as empty input
Jan 28, 2022
d18b829
Level5.java: Add reply logic to respond to unrecognised tasks/words
Jan 28, 2022
184c942
Level5.java: Update greeting message to include instructions on usage
Jan 28, 2022
352f494
Copy Todo.java over to L6
Jan 28, 2022
ed56d8e
Copy Event.java over to L6
Jan 28, 2022
24820cd
Copy Deadline.java over to L6
Jan 28, 2022
3678626
Copy Task.java over to L6
Jan 28, 2022
9688666
Copy EmptyDescException.java over to L6
Jan 28, 2022
32fb5c7
Level6.java: Add the option to delete tasks from list
Jan 28, 2022
36a8484
update Task.java to include first letter of task as an attribute of task
Feb 16, 2022
9c60d76
update Todo.java constructor method
Feb 16, 2022
78f3666
update Deadline.java constructor and toString() method
Feb 16, 2022
fb4dc79
update Event.java constructor and toString() methods
Feb 16, 2022
58af730
move EmptyDescException.java from L6 to L7 folder
Feb 16, 2022
9e3a9f8
Add Siri.txt
Feb 16, 2022
78c8798
Update Level7.java to write/read to/from Siri.txt
Feb 17, 2022
f82b7f1
Neaten a few lines of code in Level7.java
Feb 17, 2022
6167f34
Add comment in Level7.java at line 35
Feb 17, 2022
dbcfa44
Update few lines of code in Level6.java
Feb 17, 2022
b2245c5
Copy Task.java from L6 to L8 folder
Feb 17, 2022
14510b3
Copy EmptyDescException.java over from L6 to L8 folder
Feb 17, 2022
4302353
Copy Todo.java over from L6 to L8 folder
Feb 17, 2022
bd33ba3
Overload Deadline.java constructor method to take in dates and dateTime
Feb 17, 2022
03f19fd
Overload Event.java constructor method inputs to accept date or dateTime
Feb 17, 2022
a6d5116
Update Level8.java to understand dates and times in deadline/event tasks
Feb 17, 2022
cac8234
Merge branch 'branch-Level-8'
Feb 17, 2022
2dbdb6f
Add Storage.java to load/save from/to the specified text file
Feb 18, 2022
ccd7b8a
Add TaskList.java to handle adding/deleting tasks in the list
Feb 18, 2022
b8083b5
Update EmptyDescException.java name to InvalidInputException.java
Feb 18, 2022
9f3f191
Add Ui.java to handle interactions with the user
Feb 18, 2022
e0fc56f
Add Parser.java to handle the logic of the program when interacting with
Feb 18, 2022
6d80fda
Add Command.java as super class to extract more classes for the diffe…
Feb 18, 2022
bfba6da
Add AddDeadlineCommand.java to create new deadline tasks to be added …
Feb 18, 2022
d3774e3
Update AddDeadlineCommand.java to add new line of code at the end of the
Feb 18, 2022
ffb4306
Add AddEventCommand.java & AddTodoCommand.java to create new tasks to be
Feb 18, 2022
9deaec7
Add MarkCommand.java & UnmarkCommand.java to mark/unmark tasks
Feb 18, 2022
23bfca1
Add DeleteCommand.java & ListCommand.java to delete & list tasks
Feb 18, 2022
1afd47a
Add ExitCommand.java to exit the program
Feb 18, 2022
d9d8baa
Move Deadline.java, Event.java, Todo.java & Task.java over to
Feb 18, 2022
a550e3c
Add Siri.java to call all necessary methods to get Siri program to run
Feb 18, 2022
9efd004
Add siri.txt file to read/write task details in
Feb 18, 2022
4a51887
Delete Siri Folder containing level1 to level8 of iP
Feb 19, 2022
2782ffe
Package all classes into siri in src/main/java/siri
Feb 19, 2022
e2881fe
Remove some lines of unreachable code
Feb 19, 2022
de14c4b
Add DeadlineTest.java, TodoTest.java & EventTest.java to test behavio…
Feb 19, 2022
fed9f60
ignore MANIFEST.MF file
Feb 19, 2022
5feebec
Add JavaDocs comments to the code
Feb 20, 2022
c22f0ba
Tweak the code to comply with coding standards
Feb 20, 2022
ce204e4
Add FindCommand.java to handle finding of tasks with specified keyword
Feb 20, 2022
3ba2263
Add Gradle support to iP
Feb 21, 2022
ba98855
Add a GUI to Siri
Feb 21, 2022
e33d706
Add Assertions to TaskList.java
Feb 21, 2022
e9ae6aa
Improve code quality
Feb 21, 2022
a27287d
Add C-Help extension to siri
Feb 21, 2022
827dfe9
Improve code quality
Feb 21, 2022
1b474c0
Merge pull request #2 from rcjj98/branch-A-Assertions
rcjj98 Feb 21, 2022
80d93fc
Merge branch 'master' into branch-C-Help
Feb 21, 2022
edd0771
Merge pull request #4 from rcjj98/branch-C-Help
rcjj98 Feb 21, 2022
c6950de
Update both user and program profile pictures
Feb 21, 2022
6cb24d9
Add Ui.png to docs directory
Feb 21, 2022
14676ee
Give credit to peer for code reusage
Feb 21, 2022
3abc3e2
Set theme jekyll-theme-tactile
rcjj98 Feb 21, 2022
7634d94
Add a User Guide
Feb 21, 2022
7c93904
Merge branch 'master' of https://github.com/rcjj98/ip
Feb 21, 2022
a5f267d
Set theme jekyll-theme-cayman
rcjj98 Feb 21, 2022
44ba29a
Update User Guide to be neater
Feb 21, 2022
2a6484b
Merge branch 'master' of https://github.com/rcjj98/ip
Feb 21, 2022
9d8c419
Update Storage.java to write/load to/from the correct directory
Feb 21, 2022
d8b449a
Update UserGuide
Feb 21, 2022
22e7c27
Update UserGuide
Feb 21, 2022
2e40a4a
Update UserGuide in README.md file
Feb 22, 2022
31bfaa0
Remove empty comment in Storage.java
Feb 22, 2022
a163a68
Add header comments
Mar 19, 2022
8ac15d1
Add header comments
Mar 19, 2022
dc126ca
Add header comments
Mar 19, 2022
b0d1b89
Update header comments to follow Javadoc comments coding standards
Mar 19, 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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,7 @@ bin/

/text-ui-test/ACTUAL.txt
text-ui-test/EXPECTED-UNIX.TXT
*.class
MANIFEST.MF
Siri.jar
siri.txt
61 changes: 61 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
plugins {
id 'java'
id 'application'
id 'checkstyle'
id 'com.github.johnrengelman.shadow' version '5.1.0'
}

repositories {
mavenCentral()
}

dependencies {
implementation 'org.testng:testng:7.5'
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 = "siri.Launcher"
}

shadowJar {
archiveBaseName = "siri"
archiveClassifier = null
}

checkstyle {
toolVersion = '8.29'
}

run{
standardInput = System.in
}


138 changes: 125 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,141 @@
# User Guide

## Features

### Feature-ABC
1. List - Shows entire list of tasks.

2. Delete - Deletes a single specified task.

3. Add - Adds a task you wish to do.

4. deadline - Adds a task with a specific deadline.

5. event - Adds and event with a specific reminder for it.

6. mark - Marks the specified event with an 'X'.

Description of the feature.
7. unmark - Unmarks the specified marked event.

### Feature-XYZ
8. find - Shows all tasks that have that specified word.

Description of the feature.
9. help - Shows all commands & some examples.

10. bye - Ends the conversation with the program.

## Usage

### `Keyword` - Describe action
#### 1. `list`

Describe the action and its outcome.
Expected Outcome:
```
Tasks to do:
1. [T][] run 2.4km
2. [D][] CS2103T Quiz (by: Friday 2pm)
```

Example of usage:
#### 2. `delete 2`

`keyword (optional arguments)`
Expected Outcome:
```
Sure, I've removed this task from the list:
[D][] CS2103T Quiz (by: Friday 2pm)

Number of task(s) in your list: 1
```

Expected outcome:
#### 3. `todo run 10km`

Description of the outcome.
Expected Outcome:
```
This task has been added to your list:
[T][] run 10km

Number of task(s) in your list: 2
```

#### 4. `deadline iP /by 2022-02-18`

Expected Outcome:
```
This task has been added to your list:
[D][] iP (by: Feb 18th 2022)

Number of task(s) in your list: 3
```

#### 5. `event Jane's Wedding /at Fullerton Hotel`

Expected Outcome:
```
expected output
This task has been added to your list:
[E][] Jane's Wedding (at: Fullerton Hotel)

Number of task(s) in your list: 4
```

#### 6. `mark 4`

Expected Outcome:
```
This task has been marked:
[E][X] Jane's Wedding (at: Fullerton Hotel)
```

#### 7. `unmark 4`

Expected Outcome:
```
This task has been unmarked:
[E][] Jane's Wedding (at: Fullerton Hotel)
```

#### 8. `find run`

Expected Outcome:
```
Here are the matching tasks in your list:
1. [T][] run 2.4km
2. [T][] run 10km
```

#### 9. `help`

Expected Outcome:
```
Commands:
1. list
2. delete
3. todo
4. deadline
5. event
6. mark
7. unmark
8. find
9. help
10. bye

You can add 3 types of tasks to the list:
- todo
- deadline
- event

Specify the type of task then it's description to add to the list.
Deadlines and events can accept a date or location as reminders.

Examples:
- todo run a mile
- deadline return library book /by Sunday 2359
- event Jack's wedding /at Holiday Inn 1800
- delete 2
- mark 3
- find book
```

#### 10. `bye`

Expected Outcome:
```
Goodbye.
```




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.
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-cayman
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-7.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading