ip

User Guide for Duke

Lum Jian Yang Sean | A0199758Y

Welcome to Duke, a task manager app to track your todos, deadlines and events.

Table Of Contents

Introduction

A JavaFX-Powered Task Manager App

About

This is a java project created for CS2103T Software Engineering for AY2020/2021 Semester 1.

Author: Lum Jian Yang Sean
Version: 0.1.4
Release Date: 18 Sepetember 2020
Github: https://github.com/seanjyjy

Getting Started

Download the JAR file here! You can launch the app by either clicking on the jar file or java -jar Duke-0.1.4.jar in the path where you have the jar file.

Features

Usage

Notes about the command command format:

deadline

Deadline is a task with description, a completion status, a reminder status and a date. Note that the date format must follow either yyyy-mm-dd HHmm or yyyy-mm-dd. By default reminder status is set to false and could only be activated/deactivated using the remind command.

Format: deadline DESCRIPTION /by DATE

Example of usage:

deadline Project Duke submission /by 2020-12-11 2312

Expected outcome:

Got it. I've added this task:
[D][✘] Project Duke submission (by: Friday, 11 Dec 2020, 11:12pm)
Now you have <Int> tasks in the list.

event

Event is a task with description, a completion status, a reminder status and a date. Note that the date format must follow either yyyy-mm-dd HHmm or yyyy-mm-dd. By default reminder status is set to false and could only be activated/deactivated using the remind command.

Format: event DESCRIPTION /at DATE

Example of usage:

event Project Duke meeting /at 2020-12-11 2312

Expected outcome:

Got it. I've added this task:
[E][✘] Project Duke meeting (at: Friday, 11 Dec 2020, 11:12pm)
Now you have <Int> tasks in the list.

todo

Todo is a task with a description, a completion status and a reminder status. By default reminder status is set to false and could only be activated/deactivated using the remind command.

Format: todo DESCRIPTION

Example of usage:

todo Project Duke

Expected outcome:

Got it. I've added this task:
[T][✘] Project Duke
Now you have <Int> tasks in the list.

list

Your tasks will be displayed out for you.

Example of usage:

list

Expected outcome:

Here are the tasks in your list:
1.  [D][✘] Project Duke submission (by: Friday, 11 Dec 2020, 11:12pm)
2.  [E][✘] Project Duke meeting (at: Friday, 11 Dec 2020, 11:12pm)
3.  [T][✘] Project Duke

done

The task to be marked is indicated by the index after the done command, you can view the index of the task by typing list.

Format: done INDEX

Example of usage:

done 1

Expected outcome:

Nice! I've marked this task as done:
[D][✓] Project Duke submission (by: Friday, 11 Dec 2020, 11:12pm)

delete

The task to be deleted is indicated by the index after the done command, you can view the index of the task by typing list.

Format: delete INDEX

Example of usage:

delete 1

Expected outcome:

Noted. I've removed this task:
[D][✓] Project Duke submission (by: Friday, 11 Dec 2020, 11:12pm)
Now you have <Int> tasks in the list.

find

Find tasks thats contains the keyword, note that only 1 keyword is allowed currently.

Format: find KEYWORD

Example of usage:

find duke

Expected outcome:

Here are the matching tasks in your list:
[E][✘] Project Duke meeting (at: Friday, 11 Dec 2020, 11:12pm)
[T][✘] Project Duke

remind

The task to be reminded is indicated by the index after the remind command, you can view the index of the task by typing list. Also, state whether to activate or deactivate the reminder using y for yes, n for no after the remind command.

Format: remind INDEX Y/N

Example of usage:

remind 1 y

Expected outcome:

The reminder of this task Project Duke, has been activated

help

The list of commands available in duke will be displayed as well as its usage.

Example of usage:

help

Expected outcome:

Here are the list of commands available:
1. list
2. bye
3. todo 'task name' (e.g. todo task 1)
4. delete ___ (e.g. delete 1) *Note that it should be a value more than 0*
5. done ___ (e.g. done 1) *Note that it should be a value more than 0*
6. find ___ (e.g. find book) *Note that only 1 keyword is allowed*
7. remind _ _ (e.g.remind 1 y)
   *Sets reminder on task 1 in task list, y or n represents yes or no respectively*
8. deadline 'task name' /by 'any date format'
   (e.g. deadline project /by YYYY-MM-DD HHMM or YYYY-MM-DD)
9. event 'event name' /at 'any date format'
   (e.g. event project /at YYYY-MM-DD HHMM or YYYY-MM-DD)

bye

A message will be displayed and after a 1.5s delay, the program will close.

Example of usage:

help

Expected outcome:

Bye ^.^, Hope to see you again soon!!!

Command Summary

Action Command Format, Examples
Add todo todo todo DESCRIPTION

e.g.todo duke
Add event event event DESCRIPTION /at DATE

e.g.event party /at 2020-11-11 2312
Add deadline deadline deadline DESCRIPTION /by DATE

e.g.deadline project duke /by 2020-11-11 2312
Set a task on reminder remind remind INDEX Y/N

e.g. remind 1 y
Mark a task as completed done done INDEX

e.g.done 1
Delete task delete delete INDEX

e.g.delete 3
Find a task find find KEYWORD

e.g.find duke
Show all tasks list list
View all commands help help
Exit the program bye bye

FAQ

Where does duke store its task?
Duke stores its tasks in a csv file. The path for the text file can be found in ./duke.Duke/todoList.csv

What happens if I do not have ./duke.Duke directory in my computer?
Duke will automatically generate this directory for you.

What happens if I accidentally deleted the .csvfile?
Duke will automatically generate this todoList.csv for you. However, once deleted, the data is not recoverable

Duke windows too small
Duke allows interactive resizing!

Am I able to customized the colors of Duke?
Unfortunately we did not include any customized feature.

Credits

External Packages Used

Images Used