CS2113/T Website - Admin: Project: warmup [week 2]

Set up prerequisites. Get started on Duke

Set up prerequisites

Ensure you have met the following prerequisites:

Prerequisites:

Install Git in your computer.

Relevant: [Admin Tools -> Git ]

Have a GitHub account.

Relevant: [Admin Tools -> GitHub ]

Collaboration platform: You are required to use GitHub as the hosting and collaboration platform of your project (i.e., to hold the Code repository, Issue Tracker, etc.). See Appendix E for more info on how to setup and use GitHub for your project.

Create a GitHub account (if you don't have one yet), as explained in the panel below.

Relevant: [Admin Appendix E - GitHub: Creating an Account ]

Create a personal GitHub account if you don't have one yet.

You are advised to choose a sensible GitHub username as you are likely to use it for years to come in professional contexts.
Strongly recommended: Complete your GitHub profile. In particular,
- Specify your full name.
- Upload a profile photo that matches our requirements.
The GitHub profile is useful for the tutors and classmates to identify you. If you are reluctant to share your info in your long-term GitHub account, you can remove those details after the module is over or create a separate GitHub account just for the module.
You are discouraged from changing your GitHub username during the semester/exam/grading period as it can cause our auto-grading scripts to miss your GitHub activities. If you do change your GitHub username during that period, please let us know immediately.

See Appendix E - Using GitHub for more information.

Recommended: Installed an IDE in your computer.

Relevant: [Admin Tools -> IntelliJ ]

Set up the project in your computer

Fork https://github.com/nusCS2113-AY1920S1/duke.
Ensure the issue tracker of your fork is enabled. Reason: our bots will be posting your weekly progress reports on the issue tracker of your fork.
Clone the fork onto your computer.
Set up the project in your IDE as explained in the README file.

Implement increments while committing code frequently

Implement the following increments in the given order.

Commit code at important points. Minimally, commit after completing each increment.
After completing each increment,
- git tag the commit with the exact increment ID e.g., Level-2, A-TextUiTesting
- git push the code and the tags to your fork

Level-1: Greet, Echo, Exit

Level 1. Greet, Echo, Exit

In this initial skeletal version of Duke, it starts by greeting the user, simply echos commands entered by the user, and exits when the user types bye.
Example:

    ____________________________________________________________
     Hello! I'm Duke
     What can I do for you?
    ____________________________________________________________

list
    ____________________________________________________________
     list
    ____________________________________________________________

blah
    ____________________________________________________________
     blah
    ____________________________________________________________

bye
    ____________________________________________________________
     Bye. Hope to see you again soon!
    ____________________________________________________________

The indentation and horizontal lines are optional.

Level-2: Add, List

Level 2. Add, List

Add the ability to store whatever text entered by the user and display them back to the user when requested.

Example:

    ____________________________________________________________
     Hello! I'm Duke
     What can I do for you?
    ____________________________________________________________

read book
    ____________________________________________________________
     added: read book
    ____________________________________________________________

return book
    ____________________________________________________________
     added: return book
    ____________________________________________________________

list
    ____________________________________________________________
     1. read book
     2. return book
    ____________________________________________________________
bye
    ____________________________________________________________
     Bye. Hope to see you again soon!
    ____________________________________________________________

There is no need to save the data to the hard disk.
Assume there will be no more than 100 tasks. If you wish, you may use a fixed size array (e.g., String[100]) to store the items.

Level-3: Mark as Done

Level 3. Mark as Done

Add the ability to mark tasks as done.

list
    ____________________________________________________________
     Here are the tasks in your list:
     1.[✓] read book
     2.[✗] return book
     3.[✗] buy bread
    ____________________________________________________________

done 2
    ____________________________________________________________
     Nice! I've marked this task as done: 
       [✓] return book
    ____________________________________________________________

When implementing this feature, you are also recommended to implement the following extension:

A-Classes

↳ Use a class to represent tasks

While it is possible to represent a task list as a multi-dimensional array containing primitive values, the more natural approach is to use a Task class to represent tasks.

public class Task {
    protected String description;
    protected boolean isDone;

    public Task(String description) {
        this.description = description;
        this.isDone = false;
    }

    public String getStatusIcon() {
        return (isDone ? "\u2713" : "\u2718"); //return tick or X symbols
    }

    //...
}

Task t = new Taks("read book");
t.markAsDone()