What is Duke

Duke is a task bot for users to easily track their todo lists. Users can note down their tasks in three types, namely event, todo, and deadline, and add notes as well as time range to each task accordingly. Refer to the following sections for feature details!

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)
2. 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.
3. 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.
4. After that, locate the src/main/java/duke.Duke.java file, right-click it, and choose Run duke.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! I'm Duke
   Here are the tasks to be finished today:
   

User Guide

Features

Feature-CRUD

User can add (todo, deadline, event) and delete (delete + task index) a task to the task list. A task can also be marked as done (done + task index). User can view all tasks added to the task list.

Feature-Show task on a certain day

User can use get + dd/mm/yyyy keyword to get tasks on a particular day. get today can be used to quickly get tasks on a certain day.

Feature-Reminder

User can see all tasks to be done by today (particularly event and deadline types) when opening the application.

Feature-Search for a task

User can use find + keyword to search for a certain task.

Feature-Save

Tasks added to the task list is auto-saved to local files. When user reopen the application on the same device, the tasks previously added can be seen.

Usage

todo - add a task of type todo

A todo type has no time attached to it, user can choose to finish it by anytime.

Example usage: todo write essay

Expected outcome:

event - add an event task to task list

An event type has a time range to be specified by the users. The date is a must and time range is optional. event /at dd/mm/yyyy (time)

Example usage: event wash hair /at 21/09/2021 2-3pm

Expected outcome:

deadline - add a deadline task to task list

A deadline type has a time stamp to be specified by the users. The time can be input in the form of /by dd/mm/yyyy or /by dd/mm/yyyy hh:mm

Example usage: deadline finish homework /by 23/09/2021 deadline finish homework /by 23/09/2021 13:45

Expected outcome:

done - mark a task as done

Example usage: done + task index done 3 where 3 is the position of the task intended to complete in the task list.

Expected outcome:

delete - delete a task

Example usage: delete task index delete 3 where 3 is the position of the task intended to complete in the task list.

Expected outcome:

list - show all tasks added to the task list

Example usage: list

Expected outcome:

find - find tasks with specified keyword

Example usage: find class

Expected outcome:

get - get tasks on a specific date

get today to get tasks due today quickly. get dd/mm/yyyy to get tasks on the specified date.

Example usage: get today get 23/09/2021

Expected outcome:

bye - close the application

Example usage: bye

Expected outcome: The application closes.