ip

ChadBot

Chadbot application is designed for user to manage their day-to-day tasks. It is optimized for use via Command Line Interface (CLI) and Graphical User Interface (GUI). With ChadBot, you will never need to worry about missing your event and deadline again!

Content

• Quick Start
• Features
  • Add a Todo Task
  • Add a Deadline
  • Add an Event
  • Find Task by Keyword
  • View Task List
  • Mark Task as Done
  • Mark Task as Undone
  • Delete a Task
  • Exiting the Program
• Command Summary

Quick Start

Prerequisites

• JDK11
• Intellij Idea

1. Ensure you have Java 11 or above installed in your Computer.
2. Download the latest chad.jar from here.
3. Copy the file to the folder you want to use as the home folder for your ChadBot.
4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar chad.jar command to run the application.
5. ChadBot will launch and you will see the screen below. You may then proceed to explore more on what ChadBot has to offer.

Features

Add A Todo Task

Adds a Todo task into the current task list and response upon successful insertion.

Parameter(s):

• Description - Short description of the todo task you wish to add into your task list.

Command Format: todo <description>

Example of usage:

todo CS2103T Week 6 Task

Expected outcome: Returns response with the description of your todo task.

Great! I've added this task for you
 [T][ ] CS2103T Week 6 Task 
You have 1 tasks in the list.

Add a Deadline

Adds a deadline task into the current task list.

Parameter(s):

• Description - Short description of the deadline you wish to add into your task list.
• Due Date - The date

Command Format: deadline <Description> /by <Due Date>

Example of usage:

deadline CS2103T UG Submission /by 2023-02-17 2359

Expected outcome: Returns response with the description of your deadline.

Great! I've added this task for you
 [D][ ] CS2103T UG Submission (by: Feb 17 2023, 11:59PM) 
You have 1 tasks in the list.

Add an Event

Adds an event task into the current task list.

Parameter(s):

• Description - Short description of the event you wish to add into your task list.
• Start Date - Date when the event starts
• End Date - Date when the event ends

Command Format: event <Description> /from <Start Date> /to <End Date>

Example of usage:

event TP Project /from 2023-02-14 2359 /to 2023-04-14 2359

Expected outcome: Returns response with the description of your event.

Great! I've added this task for you
 [E][ ] TP Project (from: Feb 14 2023, 11:59PM to: Apr 14 2023, 11:59PM) 
You have 13 tasks in the list.

Find Task by Keyword

Find task with specified keyword in the current task list.

Parameter(s):

• Keyword - The keyword you wish to use to find the specific task in the task list.

Command Format: find <Keyword>

Example of usage:

find CS2103T

Expected outcome: Returns the found task with your specified keyword.

[D][ ] CS2103T UG Submission (by: Feb 17 2023, 11:59PM)

View Task List

View the current task list.

Command Format: list

Example of usage:

list

Expected outcome: Returns all item in the task list.

1: [T][ ] CS2103T Week 6 Task
2: [D][ ] CS2103T UG Submission (by: Feb 17 2023, 11:59PM)
3: [E][ ] TP Project (from: Feb 14 2023, 11:59PM to: Apr 14 2023, 11:59PM)

Mark Task as Done

Mark task of specified index in the current task list as done.

Parameter(s):

• Index - The index of the task you wish to mark as done. Index must be a positive number.

Command Format: mark <Index>

Example of usage:

mark 1

Expected outcome: Returns the description of the task with its status mark as done by X.

Nice! I have marked this task as done 
 [T][X] CS2103T Week 6 Task

Mark Task as UnDone

Mark task of specified index in the current task list as undone.

Parameter(s):

• Index - The index of the task you wish to mark as undone. Index must be a positive number.

Command Format: unmark <Index>

Example of usage:

unmark 11

Expected outcome: Returns the description of the task with its status unmark.

Aww! One more task on the list 
 [T][ ] CS2103T Week 6 Task

Delete a Task

Delete task of specified index in the current task list.

Parameter(s):

• Index - The index of the task you wish to delete. Index must be a positive number.

Command Format: delete <Index>

Example of usage:

delete 1

Expected outcome: Returns the description of the removed task.

Noted. I've removed this task:
 [T][ ] CS2103T Week 6 Task 
Now you have 12 tasks in the list.

Exiting the Program

Exit the Program.

Command Format: bye

Example of usage:

bye

Expected outcome: Returns the parting message.

bella ciao

Command Summary

Index	Commands	Command Format	Example Usage
1	Add a Todo Task	todo <description>	todo homework
2	Add a Deadline Task	deadline <description> /by <due date>	deadline homework /by 2023-02-17 2359
3	Add an Event	event <description> /from <start date> /to <end date>	event internship /from 2023-05-08 0800 /to 2023-07-28 1800
4	Find Task by Keyword	find <keyword>	find CS2103T
5	View Task List	list	list
6	Mark Task as Done	mark <index>	mark 5
7	Mark Task as Undone	unmark <index>	unmark 5
8	Delete a Task	delete <index>	delete 5
9	Exiting the Program	bye	bye