Skip to content

nt-nic/DukeyList

 
 

Repository files navigation

User Guide

DukeyList

DukeyList a great and easy way to manage and keep track of your tasks! Using DukeyList, you can add and remove tasks, and mark them as completed.

DukeyList is able to handle these types of tasks:

  • ToDos - Tasks that need to completed
  • Deadlines - Tasks that need to be completed by a certain date
  • Events - Tasks that span over a period
  • Loans (extension) - Tasks to keep track of debt

DukeyList Features

Task list

DukeyList keeps track of all your tasks. You can view your tasks, the task status (whether they are complete or not), the type of tasks and the deadline/dates associated with your tasks.

1. [T][ ] Buy Fruits
2. [D][X] Submit forms (by 12 Feb 2023)
3. [E][ ] Seminar (15 Feb 2023 to 16 Feb 2023)
4. [L][ ] Gas money: Brother owes $10 to Mother

Add Tasks

Add a new task to DukeyList. DukeyList will continue to keep track of the task until it is deleted from the list.

Mark/Unmark Tasks

Should you be done with a task, you can mark it as done. DukeyList represents marked tasks with an 'X':

2. [D][X] Submit forms (by 12 Feb 2023)

Similarly, tasks can be unmarked as well.

Delete Tasks

You can delete a task from DukeyList. The task will no longer be shown on the list after deletion.

Find Tasks

You can search for tasks using a certain keyword. DukeyList will return you a list of tasks containing the keyword, if there are any.

DukeyList found these tasks matching the keyword "buy":
1. [T][ ] Buy Fruits

Save

You can save DukeyList locally, meaning that your tasks will be stored even after you exit the DukeyList app. DukeyList automatically loads up the most recent save whenever it starts.

Starting up DukeyList

Once you start up DukeyList, it will automatically load up your most recent save, if any. Should there be a saved list, you will see the following message:

Saved list loaded:

If there is no previous save, the following message will show instead. This means that you will start with a new empty list.

DukeyList empty, starting a new list:

You can now start typing commands into DukeyList!

##Using DukeyList To use DukeyList, type in a command, followed by necessary fields and press enter. Each field is separated by a '/' character. The command is also followed by the '/' character. The format and usages of various commands are shown below. Note that commands are not case-sensitive. Be sure to follow the formats as closely as you can! Using a command with the incorrect format for fields will lead to errors. Invalid commands or fields will also result in errors.

list - Shows DukeyList tasks

The list commands lists out all the tasks in DukeyList.

Usage of list:

list

Expected outcome:

1. [T][ ] Buy Fruits
2. [D][X] Submit forms (by 12 Feb 2023)
3. [E][ ] Seminar (15 Feb 2023 to 16 Feb 2023)
4. [L][ ] Gas money: Brother owes $10 to Mother

todo - Add a new ToDo

The todo command adds a new ToDo to the DukeyList. A ToDo requires the following fields:

  1. name

The format for adding a Todo is shown below:

todo / <name>

Example of usage:

todo / Buy Fruits

Expected outcome:

DukeyList just added a new todo:
[T][ ] Buy Fruits
DukeyList now has 5 tasks.

DukeyList will show a confirmation message along with the created ToDo.

deadline - Add a new Deadline

The deadline command adds a new Deadline to the DukeyList. A Deadline requires the following fields:

  1. name
  2. deadline in the form yyyy-mm-dd

The format for adding a Deadline is shown below:

deadline / <name> / <deadline>

Example of usage:

deadline / Submit Forms / 2023-02-12

Expected outcome:

DukeyList just added a new deadline:
[D][ ] Submit Forms (by 12 Feb 2023)
DukeyList now has 5 tasks.

DukeyList will show a confirmation message along with the created ToDo.

event - Add a new Event

The event command adds a new Event to the DukeyList. An Event requires the following fields:

  1. name
  2. start date in the form yyyy-mm-dd
  3. end date in the form yyyy-mm-dd

The format for adding an Event is shown below:

event / <name> / <start> / <end> 

Example of usage:

event / Seminar / 2023-02-15 / 2023-02-16

Expected outcome:

DukeyList just added a new event:
[E][ ] Seminar (15 Feb 2023 to 16 Feb 2023)
DukeyList now has 5 tasks.

DukeyList will show a confirmation message along with the created Event.

loan - Add a new Loan

The loan command adds a new Event to the DukeyList. A Loan requires the following fields:

  1. name
  2. borrower
  3. lender
  4. amount (must be a number)

The format for adding an Event is shown below:

loan / <name> / <borrower> / <lender> / <amount> 

Example of usage:

loan / Gas money / Brother / Mother / $10

Expected outcome:

DukeyList just added a new loan:
[L][ ] Gas money: Brother owes $10 to Mother
DukeyList now has 5 tasks.

DukeyList will show a confirmation message along with the created Loan.

mark - Mark a task

The mark command marks a task as completed. mark requires the following fields:

  1. task number (must be a number)

The format for adding an Event is shown below:

mark / <task number> 

Example of usage:

mark / 1

Expected outcome:

Task number 1 has been marked as done!
1. [T][X] Buy Fruits

DukeyList will show a confirmation message along with the marked task.

unmark - Unmark a task

The unmark command marks a task as incomplete. unmark requires the following fields:

  1. task number (must be a number)

The format for adding an Event is shown below:

unmark / <task number> 

Example of usage:

unmark / 1

Expected outcome:

Task number 1 has been unmarked.
1. [T][ ] Buy Fruits

DukeyList will show a confirmation message along with the unmarked task.

delete - delete a task

The delete command marks a task as incomplete. delete requires the following fields:

  1. task number (must be a number)

The format for adding an Event is shown below:

delete / <task number> 

Example of usage:

delete / 1

Expected outcome:

The following task has been removed!
[T][ ] Buy Fruits
DukeyList now has 4 tasks.

DukeyList will show a confirmation message along with the deleted task.

find - Find tasks

The find command finds and shows all tasks with a certain keyword. find requires the following fields:

  1. keyword

The format for adding an Event is shown below:

delete / <keyword> 

Example of usage:

find / buy

Expected outcome:

DukeyList found the following tasks with the keyword 'buy':
[T][ ] Buy Fruits
[T][X] Buy Water

DukeyList will show a confirmation message along with the list of tasks with the keyword.

clearList - Clears DukeyList

The clearList command deletes all the tasks currently on DukeyList.

Usage:

clearList

Expected outcome:

DukeyList cleared!

DukeyList will show a confirmation message.

save - Save DukeyList

The save command saves a copy of the current DukeyList locally.

Usage:

save

Expected outcome:

DukeyList saved!

DukeyList will show a confirmation message.

bye - Exits DukeyList

The bye command autosaves DukeyList and exits the application.

Usage:

bye

Expected outcome:

DukeyList saved! Goodbye! Please return to DukeyList soon!
Exiting...

DukeyList will show a confirmation message.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 97.2%
  • Shell 1.6%
  • Batchfile 1.2%