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

[Tyrus Lye]iP #557

Open
wants to merge 36 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
28ad2b8
Add Gradle support
May 24, 2020
ed6d4d2
Bump gradle and lib version
Eclipse-Dominator Aug 5, 2023
8664014
Level-0
TyrusLye Aug 23, 2023
892b284
Level-1
TyrusLye Aug 23, 2023
3f22749
Level-2
TyrusLye Aug 23, 2023
bfe5fea
Level-3
TyrusLye Aug 23, 2023
12b399e
Level-4
TyrusLye Aug 24, 2023
9a3f089
A-TextUiTesting
TyrusLye Aug 24, 2023
3f9bc73
Level-5
TyrusLye Aug 24, 2023
c8920e9
Level-6
TyrusLye Aug 24, 2023
937f61c
it doesnt work and i hate my life
TyrusLye Sep 6, 2023
f0cc53b
Level-7
TyrusLye Sep 6, 2023
5310a44
Level-8
TyrusLye Sep 6, 2023
1579d0c
Merge branch 'add-gradle-support'
TyrusLye Sep 10, 2023
6ff52fa
Add-gradle
TyrusLye Sep 10, 2023
22c309f
A-JavaDoc
TyrusLye Sep 22, 2023
bc05937
Level-9
TyrusLye Sep 22, 2023
918f5c8
Update README.md
TyrusLye Sep 22, 2023
47a247e
Update README.md
TyrusLye Sep 22, 2023
ccd2127
Just gonna commit this one before I start messing things up too much
TyrusLye Sep 23, 2023
724286a
Level-10
TyrusLye Sep 23, 2023
d9e7d80
Just bug fixes honestly
TyrusLye Sep 26, 2023
25866f1
Merge branch 'master' of https://github.com/TyrusLye/ip
TyrusLye Sep 26, 2023
904d88d
A-UI
TyrusLye Sep 27, 2023
56b0750
A-UserGuide
TyrusLye Sep 27, 2023
0b4d08c
A few small edits and corrections
TyrusLye Sep 27, 2023
7273363
Deadline and list bug fixes
TyrusLye Oct 1, 2023
2da97b5
Fixing formatting issues
TyrusLye Oct 1, 2023
4f32000
Add Ui.png
TyrusLye Oct 1, 2023
54290c6
Adding more OOP
TyrusLye Oct 23, 2023
c028425
Adding more OOP
TyrusLye Oct 23, 2023
e73f390
Merge pull request #3 from TyrusLye/A-MoreOOP
TyrusLye Oct 23, 2023
4d45b43
A-Storage
TyrusLye Oct 23, 2023
3c69f79
Merge pull request #4 from TyrusLye/branch-Level-9
TyrusLye Oct 23, 2023
0efd428
A-Assertions
TyrusLye Oct 23, 2023
70cbc5f
Merge pull request #5 from TyrusLye/A-Assertions
TyrusLye Oct 23, 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
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# Duke project template
# URBOI

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.
Are you confused? Lost all the time? Don't know whats happening? **Well So Do I*. Introducing; _URBOI_. THE BEST THING REMEMBERER IN TOWN.

## Setting up in Intellij
## It can:
- Help you remember things!
- Set deadlines for things!
- Makes finding the things you need to do easy!

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

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
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```
UUUUUUUU UUUUUUUURRRRRRRRRRRRRRRRR BBBBBBBBBBBBBBBBB OOOOOOOOO IIIIIIIIII
U::::::U U::::::UR::::::::::::::::R B::::::::::::::::B OO:::::::::OO I::::::::I
U::::::U U::::::UR::::::RRRRRR:::::R B::::::BBBBBB:::::B OO:::::::::::::OO I::::::::I
UU:::::U U:::::UURR:::::R R:::::RBB:::::B B:::::BO:::::::OOO:::::::OII::::::II
U:::::U U:::::U R::::R R:::::R B::::B B:::::BO::::::O O::::::O I::::I
U:::::D D:::::U R::::R R:::::R B::::B B:::::BO:::::O O:::::O I::::I
U:::::D D:::::U R::::RRRRRR:::::R B::::BBBBBB:::::B O:::::O O:::::O I::::I
U:::::D D:::::U R:::::::::::::RR B:::::::::::::BB O:::::O O:::::O I::::I
U:::::D D:::::U R::::RRRRRR:::::R B::::BBBBBB:::::B O:::::O O:::::O I::::I
U:::::D D:::::U R::::R R:::::R B::::B B:::::BO:::::O O:::::O I::::I
U:::::D D:::::U R::::R R:::::R B::::B B:::::BO:::::O O:::::O I::::I
U::::::U U::::::U R::::R R:::::R B::::B B:::::BO::::::O O::::::O I::::I
U:::::::UUU:::::::U RR:::::R R:::::RBB:::::BBBBBB::::::BO:::::::OOO:::::::OII::::::II
UU:::::::::::::UU R::::::R R:::::RB:::::::::::::::::B OO:::::::::::::OO I::::::::I
UU:::::::::UU R::::::R R:::::RB::::::::::::::::B OO:::::::::OO I::::::::I
UUUUUUUUU RRRRRRRR RRRRRRRBBBBBBBBBBBBBBBBB OOOOOOOOO IIIIIIIIII
60 changes: 60 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
plugins {
id 'java'
id 'application'
id 'com.github.johnrengelman.shadow' version '7.1.2'
}

repositories {
mavenCentral()
}

dependencies {
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'

String javaFxVersion = '17.0.7'

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 {
mainClass.set("URBOI_PACKIN")
mainClassName= "URBOI_PACKIN.Launcher"
}

shadowJar {
archiveFileName = 'duke.jar'
archiveBaseName = "duke"
archiveClassifier = null
dependsOn("distZip", "distTar")
}

run{
standardInput = System.in
}
115 changes: 101 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,116 @@
# User Guide
# URBOI Chatbot User Guide

## Features
## Introduction

### Feature-ABC
URBOI is a simple command-line chatbot designed to help you manage your tasks. It allows you to add, list, mark as done, delete, and search for tasks. This user guide will provide you with step-by-step instructions on how to use URBOI effectively.

Description of the feature.
## Table of Contents
- [Getting Started](#getting-started)
- [Adding Tasks](#adding-tasks)
- [Adding a To-Do](#adding-a-to-do)
- [Adding a URBOI_PACKIN.TaskTypes.Deadline](#adding-a-deadline)
- [Adding an URBOI_PACKIN.TaskTypes.Event](#adding-an-event)
- [Listing Tasks](#listing-tasks)
- [Marking Tasks as Done](#marking-tasks-as-done)
- [Deleting Tasks](#deleting-tasks)
- [Searching for Tasks](#searching-for-tasks)
- [Exiting URBOI_PACKIN.ResponseController](#exiting-duke)
- [Saving Your Tasks](#saving-your-tasks)

### Feature-XYZ
## Getting Started<a name="getting-started"></a>

Description of the feature.
1. Clone or download the URBOI project code from [GitHub](https://github.com/TyrusLye/ip/releases/tag/A-Release).
2. Run the `URBOI.java` file to start the URBOI_PACKIN.ResponseController chatbot.

## Usage
## Adding Tasks<a name="adding-tasks"></a>

### `Keyword` - Describe action
URBOI_PACKIN.ResponseController allows you to add three types of tasks: To-Do, URBOI_PACKIN.TaskTypes.Deadline, and URBOI_PACKIN.TaskTypes.Event.

Describe the action and its outcome.
### Adding a To-Do<a name="adding-a-to-do"></a>

Example of usage:
To add a To-Do task, use the following command:

`keyword (optional arguments)`
```plaintext
todo [description]
```

Replace `[task description]` with a brief description of the to-do task you want to add.

Expected outcome:
### Adding a URBOI_PACKIN.TaskTypes.Deadline <a name="adding-a-deadline"></a>

Description of the outcome.
To add a deadline task, use the following command:

```plaintext
deadline [task description] /by [date and time]
```
expected output

Replace `[task description]` with a description of the deadline task and `[date and time]` with the date and time the task is due in the format `d/M/yyyy HHmm`.

### Adding an URBOI_PACKIN.TaskTypes.Event <a name="adding-an-event"></a>

To add an event task, use the following command:

```plaintext
event [event description] /from [start time] /to [end time]
```

Replace `[event description]` with a description of the event, `[start time]` with the event's start time, and `[end time]` with the event's end time.

## 3. Listing Tasks <a name="listing-tasks"></a>

To see a list of all your tasks, simply enter:

```plaintext
list
```


## 4. Marking Tasks <a name="marking-tasks"></a>

You can mark tasks as done or undone using the following commands:

- To mark a task as done, use:

```plaintext
mark [task index]
```

Replace `[task index]` with the index of the task you want to mark as done.

- To mark a task as not done (undone), use:

```plaintext
unmark [task index]
```

Replace `[task index]` with the index of the task you want to mark as not done.

## 5. Deleting Tasks <a name="deleting-tasks"></a>

You can delete a task from your list using the following command:

```plaintext
delete [task index]
```

Replace `[task index]` with the index of the task you want to delete.

## 6. Searching for Tasks <a name="searching-for-tasks"></a>

To search for tasks containing a specific keyword, use the following command:

```plaintext
find [keyword]
```

Replace `[keyword]` with the keyword you want to search for. URBOI_PACKIN.ResponseController will display a list of tasks matching your keyword.

## 7. Exiting URBOI_PACKIN.ResponseController <a name="exiting-duke"></a>

To exit URBOI_PACKIN.ResponseController, simply enter:

```plaintext
bye
```

URBOI_PACKIN.ResponseController will bid you farewell and close.
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.
7 changes: 7 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading