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

[bryanongjx] iP #379

Open
wants to merge 49 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
556af3f
Add Gradle support
May 24, 2020
e2dc23c
first commit
bryanongjxairetec Jan 19, 2023
9db8e00
Revert "first commit"
bryanongjxairetec Jan 19, 2023
20ce1ef
Level 1 Commit
bryanongjxairetec Jan 19, 2023
e948091
second commit
bryanongjxairetec Jan 19, 2023
89bdac5
level 3 commit
bryanongjxairetec Jan 30, 2023
7b40056
Level 4 commit
bryanongjxairetec Jan 30, 2023
81c9a07
Level 5 Commit
bryanongjxairetec Jan 30, 2023
7214d96
Level 6 commit
bryanongjxairetec Jan 30, 2023
cf92c42
Level 7 Commit
bryanongjxairetec Feb 6, 2023
5a3100f
Revert "Level 7 Commit"
bryanongjx Feb 7, 2023
58a445a
added date feature
bryanongjx Feb 7, 2023
4f6015e
Merge branch 'branch-Level-8'
bryanongjx Feb 7, 2023
1b62400
Added classes Parser, Storage, TaskList and Ui
bryanongjx Feb 13, 2023
7f63b95
Moved classes to a single packed "duke"
bryanongjx Feb 13, 2023
a3e7ddd
Merge remote-tracking branch 'origin/add-gradle-support'
bryanongjx Feb 13, 2023
3b342e4
Add gradle files
bryanongjx Feb 13, 2023
66cf005
add JUnit Testing (for addition of todo, events and deadlines)
bryanongjx Feb 13, 2023
7304d67
Added java docs
bryanongjx Feb 13, 2023
8149068
Merge branch 'branch-A-JavaDoc'
bryanongjx Feb 13, 2023
a751546
Edit code to comply with java coding standard
bryanongjx Feb 14, 2023
a4305f5
add Find feature to locate tasks by keyword
bryanongjx Feb 14, 2023
75434c3
add image of tick for readme
bryanongjx Feb 14, 2023
d0ee74a
Update README.md
bryanongjx Feb 14, 2023
89cb4cb
add GUI using JavaFX
bryanongjx Feb 14, 2023
9a048bb
Merge branch 'master' of https://github.com/bryanongjx/ip
bryanongjx Feb 14, 2023
6b62d7c
add assertions to TaskList methods: getTaskList & findTask
bryanongjx Feb 14, 2023
281887a
Merge pull request #2 from bryanongjx/branch-A-Assertions
bryanongjx Feb 14, 2023
ec4f38b
amend storage methods for cleaner code quality
bryanongjx Feb 16, 2023
125a1ba
Improve code quality by abstracting out parser commands
bryanongjx Feb 16, 2023
54966ee
corrected bugs from previous commit of improving code quality
bryanongjx Feb 16, 2023
4c1d6c5
improve GUI
bryanongjx Feb 16, 2023
cb80e43
Revert "improve GUI"
bryanongjx Feb 16, 2023
9773ae4
Revert "Revert "improve GUI""
bryanongjx Feb 16, 2023
abc3980
add screenshot for user guide
bryanongjx Feb 16, 2023
61ba68b
update user guide
bryanongjx Feb 16, 2023
8ce8ade
minor fixes
bryanongjx Feb 20, 2023
ec6df17
add text ui test
bryanongjx Feb 20, 2023
56e199b
reset user guide
bryanongjx Feb 20, 2023
d0d6670
add user guide with set up instructions and feature usages
bryanongjx Feb 20, 2023
c10b1b7
edit readme
bryanongjx Feb 20, 2023
9625384
add image for user and duke
bryanongjx Feb 20, 2023
3a259b7
rename and move Ui screenshot
bryanongjx Feb 20, 2023
0d4c3b6
rename and move ui screenshot
bryanongjx Feb 20, 2023
5df8906
edit directory link of user guide screenshot
bryanongjx Feb 20, 2023
c490000
fix format of user guide
bryanongjx Feb 20, 2023
76ab484
fix format of user guide
bryanongjx Feb 20, 2023
2bdc84d
fixed format of userguide
bryanongjx Feb 20, 2023
9b15285
fixed format of user guide
bryanongjx Feb 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
59 changes: 35 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,35 @@
# 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.

## Setting up in Intellij

Prerequisites: JDK 11, update Intellij to the most recent version.

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
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```
# Tick Pro

> "For every minute spent organising, an hour is earned" - Tick from Brawl Stars

"Tick OP" - every salty brawl stars player

![This is an image](/assets/tick.png)

Tick Pro frees your mind of having to remember things you need to do. It's,
- text-based
- easy to learn
- ~~FAST~~ SUPER FAST to learn

## Setting it up
1. download **Tick Pro (v0.2)** from [here](https://github.com/bryanongjx/ip/releases/tag/A-Release)
2. double-click it
3. add your tasks
4. let it manage tasks for you :wink:

and it's **FREE**!! :money_mouth_face:

Features:
- [x] Managing tasks
- [x] Managing deadlines
- [ ] Reminders (coming soon)

If you are a java programmer, you can use it to practice java too. Here's
the main method:
```
public class Main {
public static void main(String[] args) {
Application.launch(MainApp.class, args);
}
}
```
Binary file added assets/tick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
plugins {
id 'java'
id 'application'
id 'com.github.johnrengelman.shadow' version '5.1.0'
}

repositories {
mavenCentral()
}

dependencies {
String javaFxVersion = '11'
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'

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
}
7 changes: 7 additions & 0 deletions data/duke.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[D]/!@#&/ /!@#&/high/!@#&/hello/!@#&/02/01/2021
[T]/!@#&/ /!@#&/ /!@#&/hello
[T]/!@#&/ /!@#&/ /!@#&/hello
[T]/!@#&/ /!@#&/ /!@#&/hello
[T]/!@#&/ /!@#&/ /!@#&/hello
[T]/!@#&/ /!@#&/ /!@#&/hello
[T]/!@#&/ /!@#&/ /!@#&/hello
170 changes: 156 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,171 @@
# User Guide
# User Guide for Tick Pro

## Features
![This is an image](Ui.png)

### Feature-ABC
## Getting Started

Description of the feature.
1. Have Java 11 installed on your device.
2. Download the latest version of Duke from here.
3. Copy the file to the folder you want to use as the home folder for Duke.
4. Double click the application to run
5. Enter your command in the text box and press enter to execute command. Refer to the features below on the various commands.

### Feature-XYZ
## Features

Description of the feature.
### Feature - Adding Tasks
*Adds a task into the list*

## Usage
#### Usage - Todo
Command:
```
todo <description>
Eg. todo Read Book
```

Expected output:
```
Got it. I've added this task:
[T][] Read Book
Priority:
Now you have 1 tasks in the list.
```

#### Usage - Deadline
Command:
```
deadline <description> /by <YYYY-MM-DD>
Eg. deadline Finish CS2100 Quiz /by 2021-01-02
```

Expected output:
```
Got it. I've added this task:
[D][] Finish CS2100 Quiz (02/01/2021)
Priority:
Now you have 2 tasks in the list.
```

#### Usage - Event
Command:
```
event <description> /from <start> /to <end>
Eg. event Industry Talk /from 03/06/2021 2pm /to 03/06/2021 4pm
```
Expected output:
```
Got it. I've added this task:
[E][] Industry Talk (from: 03/06/2021 2pm to: 03/06/2021 4pm)
Priority:
Now you have 3 tasks in the list.
```

### Feature - List
*Displays all tasks in your list*
#### Usage
Command:
`list`

Expected output:
```
Here are the tasks in your list:
1. [T][] Read Book
Priority:
2. [D][] CS2100 Quiz (02/01/2021)
Priority:
3. [E][] Industry Talk (from: 03/06/2021 2pm to: 03/06/2021 4pm)
```

### Feature - Mark
*Marks a task in your list as completed*
#### Usage
Command:
```
mark <task_number>
Eg. mark 2
```

Expected output:
```
Nice! I've marked this task as done:
[D][X] CS2100 Quiz (02/01/2021)
Priority:
```

### `Keyword` - Describe action
### Feature - Unmark
*Marks a task in your list as not completed*
#### Usage
Command:
```
unmark <task_number>
Eg. unmark 2
```

Describe the action and its outcome.
Expected output:
```
Nice! I've marked this task as not done:
[D][ ] CS2100 Quiz (02/01/2021)
Priority:
```

### Feature - Delete
*Deletes a task in your list*
#### Usage
Command:
```
delete <task_number>
Eg. delete 1
```

Example of usage:
Expected output:
```
Noted. I've removed this task:
[T][ ] Read Book
Priority:
```

`keyword (optional arguments)`
### Feature - Find
*Searches for matching tasks in your list based on a keyword*
#### Usage
Command:
```
find <keyword>
Eg. find talk
```

Expected outcome:
Expected output:
```
Here are the matching tasks in your list with the keyword "talk":
1. [E][ ] Industry Talk (from: 23/12/2023 10am to: 23/12/2023 12pm)
Priority:
2. [E][ ] Career Talk (from: 02/03/2023 12pm to: 02/03/2023 2pm)
Priority
3. [T][ ] Talk with friends
Priority:
```

Description of the outcome.
### Feature - Priority
*Sets the priority for a task (low / medium / high)*
#### Usage
Command:
```
priority <task_number> <priority_level>
Eg. priority 1 high
```

Expected output:
```
Nice! I've assigned this task:
[D] CS2100 Quiz (02/03/2021)
Priority: high
as high priority
```
expected output

### Feature - Bye
*Exits the application*
#### Usage
Command: `bye`

Expected output:
```
Bye! Hope to see you again soon!
```
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