Giter Club home page Giter Club logo

ip's Introduction

Duke Zeh

Duke Zeh is a task management application based on Project Duke.

Screenshot of application

User Guide

Running Duke Zeh

  1. Download the dukezeh.jar here.
  2. It is recommended to move dukezeh.jar to an isolated folder.
  3. Open the terminal and navigate to folder where dukezeh.jar is located.
  4. Run java -jar dukezeh.jar.

Command List

Add ToDo Task

Adds a new task with no datetime attached.

  • Note that the <task-name> cannot be empty.
todo <task-name>

Add Deadline Task

Adds a new task with a deadline attached.

  • <task-name> cannot be empty.
  • Datetime format must adhere to dd-MM-yyyy HH:mm.
deadline <task-name> \by <dd-MM-yyyy HH:mm>

Add Event Task

Adds a new task with a start datetime and end datetime.

  • <task-name> cannot be empty.
  • Datetime format must adhere to dd-MM-yyyy HH:mm.
event <task-name> \from <dd-MM-yyyy HH:mm> \to <dd-MM-yyyy HH:mm>

List Tasks

List out all tasks saved in the list.

list

Mark Task

Marks a task as done based on specified index.

  • <task-number> is based on the displayed index of task.
mark <task-number>

Unmark Task

Marks a task a not done based on specified index.

  • <task-number> is based on the displayed index of task.
unmark <task-number>

Delete Task

Deletes a given task based on specified index. Tasks after the deleted task will have its index shifted.

  • <task-number> is based on the displayed index of task.
  • Task deletion can cause displayed indexes to change. Recommended to call list after delete operation.
delete <task-number>

Add Task Priority

Assigns a priority to a task based on specified index and value.

  • <task-number> is based on the displayed index of task.
  • By default no priority (priority none) is attached to all added tasks.
  • <priority-value> ONLY accepts high, low or none.
  • priority value of none will remove the given priority to the task.
priority <task-number> <priority-value>

Find Task

Lists tasks whose <task-name> contains all characters of <keyword> in order.

  • <keyword> cannot be empty but can contain .
find <keyword>

Exiting Program

Program can be exited through closing the window or running the bye command.

bye

Acknowledgements

Many thanks to the professors in charge of CS2103. Many of their resources provided have been referenced for learning.

Peers participating in the forum have also been helpful towards development of this project.

Most of the JavaFX code setup has been reused based on their tutorial guide.

The code base also attempts to adhere to the following Java style guide.

The textbook also served as an important guide in this software development project.

ip's People

Contributors

damithc avatar eclipse-dominator avatar j-lum avatar jiachen247 avatar kohguanzeh avatar seanleong339 avatar

ip's Issues

Sharing iP code quality feedback [for @KohGuanZeh]

@KohGuanZeh 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/duke/ui/MainWindow.java lines 84-91:

    /**
     * For closing program by using the bye command.
     * Sleeps for specified milliseconds before closing the stage.
     * During this time, userInput and sendButton will be disabled.
     * If InterruptException is thrown, window closes immediately after printing error.
     *
     * @param millisDelay Delay before closing in milliseconds.
     */

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 @KohGuanZeh] - Round 2

@KohGuanZeh We did an automated analysis of your code to detect potential areas to improve the code quality. The script did not detect any issues in your code (nice!).

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only 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

No easy-to-detect issues 👍

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.