ip's Introduction

GuanGuan

GuanGuan is designed for efficient task management to streamline your daily tasks and enhance productivity.

Setting up in Intellij

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

Open Intellij (if you are not in the welcome screen, click File > Close Project to close the existing project first)
Open the project into Intellij as follows:
1. Click Open.
2. Select the project directory, and click OK.
3. If there are any further prompts, accept the defaults.
Configure the project to use JDK 11 (not other versions) as explained in here.
In the same dialog, set the Project language level field to the SDK default option.
After that, locate the src/main/java/guanguan.Launcher.java file, right-click it, and choose Run Launcher.main() (if the code editor is showing compile errors, try restarting the IDE).

Features:

Words in UPPER_CASE are the parameters to be supplied by the user.
Input DATE format should be YYYY-MM-DD.
Example, in deadline DESCRIPTION /by DATE, DESCRIPTION and DATE are parameters which can be used as deadline complete CS2103T tutorial /by 2024-05-05.
Parameters can be in any order.

List tasks: `list`

List all tasks in the task list.

Format: list

Output:

Here are the tasks in your list:
1. [T][] complete CS2103T tutorial
2. [D][] dance practice (by: May 05 2024)

Add todo: `todo`

Add a todo task to the task list.

Format: todo DESCRIPTION

Examples:

todo complete CS2103T tutorial

Output:

Got it. I've added this task:
[T][] complete CS2103T tutorial
Now you have 1 tasks in the list.

Add deadline: `deadline`

Add a deadline task to the task list.

Format: deadline DESCRIPTION /by DATE

Examples:

deadline complete CS2103T tutorial /by 2024-05-05

Output:

Got it. I've added this task:
[D][] complete CS2103T tutorial (by: May 05 2024)
Now you have 1 tasks in the list.

Add event: `event`

Add an event task to the task list.

Format: event DESCRIPTION /from DATE /to DATE

Examples:

event complete CS2103T tutorial /from 2024-05-05 /to 2024-05-15

Output:

Got it. I've added this task:
[E][] complete CS2103T tutorial (from: May 05 2024 to: May 15 2024)
Now you have 1 tasks in the list.

Mark task: `mark`

Mark task as done.

Format: mark INDEX

Examples:

mark 1

Output:

Nice! I've marked this task as done:
[T][X] complete CS2103T tutorial

Unmark task: `unmark`

Mark task as undone.

Format: unmark INDEX

Examples:

unmark 1

Output:

OK, I've marked this task as not done yet:
[T][] complete CS2103T tutorial

Delete task: `delete`

Delete task from the task list.

Format: delete INDEX

Examples:

delete 1

Output:

Noted. I've removed this task:
[T][] complete CS2103T tutorial
Now you have 0 tasks in the list.

Find task: `find`

Find tasks that contain the keyword.

Format: find KEYWORD

Examples:

find tut

Output:

Here are the tasks in your list:
1. [T][] complete CS2103T tutorial

Exit: `bye`

Exit the program.

Format: bye

Output:

Bye. Hope to see you again soon!

Saving the data

Data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

Editing the data file

Data are saved automatically as a text file [JAR file location]/data/tasks.txt. Advanced users are welcome to update data directly by editing that data file.

Command Summary

Action	Format
Add Todo	`todo DESCRIPTION`
Add Deadline	`deadline DESCRIPTION /by DATE`
Add Event	`event DESCRIPTION /from DATE /to DATE`
List	`list`
Mark	`mark INDEX`
Unmark	`unmark INDEX`
Delete	`delete INDEX`
Find	`find KEYWORD`
Exit	`bye`

Acknowledgements

GitHub Copilot is used to generate JavaDoc, but all generated comments are vetted and modified when needed to ensure that they are accurate.

ip's People

Contributors

Watchers

ip's Issues

Sharing iP code quality feedback [for @guanquann]

@guanquann We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

No easy-to-detect issues 👍

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/guanguan/GuanGuan.java lines 38-40:

    /**
     * Responsibe for running the chatbot.
     */

Example from src/main/java/guanguan/Task.java lines 38-40:

    /**
     * Mark task as done.
     */

Example from src/main/java/guanguan/Task.java lines 45-47:

    /**
     * Mark task as not done.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message

No easy-to-detect issues 👍

Aspect: Binary files in repo

No easy-to-detect issues 👍

ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.

Sharing iP code quality feedback [for @guanquann] - Round 2

@guanquann We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

No easy-to-detect issues 👍

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/guanguan/GuanGuan.java lines 38-40:

    /**
     * Responsibe for running the chatbot.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message

No easy-to-detect issues 👍

Aspect: Binary files in repo

No easy-to-detect issues 👍

❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality issues.

Recommend Projects

guanquann / ip Goto Github PK

ip's Introduction

GuanGuan

Setting up in Intellij

Features:

List tasks: list

Add todo: todo

Add deadline: deadline

Add event: event

Mark task: mark

Unmark task: unmark

Delete task: delete

Find task: find

Exit: bye

Saving the data

Editing the data file

Command Summary

Acknowledgements

ip's People

Contributors

Watchers

ip's Issues

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message

Aspect: Binary files in repo

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message

Aspect: Binary files in repo

Recommend Projects

Recommend Topics

Recommend Org

List tasks: `list`

Add todo: `todo`

Add deadline: `deadline`

Add event: `event`

Mark task: `mark`

Unmark task: `unmark`

Delete task: `delete`

Find task: `find`

Exit: `bye`