Skip to content

antonio-ng-2357/ip

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Duke project template

This is a project template for a greenfield Java project. It's named after the Java mascot Duke. Given below are instructions on how to use it.

User Guide

Command Words Supported

  1. Create task:
    1. todo
      • Required format: todo [description]
    2. event
      • Required format: event [description] /at [sometime]
    3. deadline
      • Required format: deadline [description] /by [sometime]
  2. View list of tasks: list
    • Required format: list
    • Returns a list of tasks
  3. Mark task as done: done
    • Required format: done [task number in list]
    • Task number must be less than or equal to total number of tasks
  4. Delete tasks: delete
    • Required format: delete [task number in list]
    • Task number must be less than or equal to total number of tasks
  5. Search for words: find
    • Required format: find [single non-spaced word]
  6. bye
    • Terminates program

Features

  • The list of tasks saves to hard drive, but the data will not reflect if you have marked it as done. (See section Bugs and Issues)

Bugs and Issues

  • If you mark a task as done, it does not save to hard drive. So if you close and open the app and look at the list, all the tasks will be marked as undone.
  • Most errors are not handled. So if you write symbols like \ instead of /, or do not follow the correct format for event or deadline, the app will crash.

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 dialog first)
  2. Set up the correct JDK version, as follows:
    1. Click Configure > Structure for New Projects and then Project Settings > Project > Project SDK
    2. If JDK 11 is listed in the drop down, select it. If it is not, click New... and select the directory where you installed JDK 11
    3. Click OK
  3. Import the project into Intellij as follows:
    1. Click Open or Import.
    2. Select the project directory, and click OK
    3. If there are any further prompts, accept the defaults.
  4. After the importing is complete, locate the src/main/java/Duke.java file, right-click it, and choose Run Duke.main(). If the setup is correct, you should see something like the below:
    Hello from
     ____        _        
    |  _ \ _   _| | _____ 
    | | | | | | | |/ / _ \
    | |_| | |_| |   <  __/
    |____/ \__,_|_|\_\___|
    

About

Starter code for the Duke project

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Java 80.5%
  • Batchfile 11.6%
  • Shell 7.9%