Skip to content

Starter code for CS2103DE individual project

Notifications You must be signed in to change notification settings

nus-cs2103de-ay2425s2/duke

 
 

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.

Setting up in IntelliJ

Prerequisites: JDK 21.

  1. Open IntelliJ (if you are not in the welcome screen, click File > Close Project to close the existing project first)
  2. Open the project into IntelliJ as follows:
    1. Click Open.
    2. Select the project directory, and click OK.
    3. If there are any further prompts, accept the defaults.
  3. Configure the project to use JDK 21 (not other versions) as explained in here.
    In the same dialog, set the Project language level field to the SDK default option.
  4. After that, locate the src/main/java/Duke.java file, right-click it, and choose Run Duke.main() (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
    Hello from
     ____        _        
    |  _ \ _   _| | _____ 
    | | | | | | | |/ / _ \
    | |_| | |_| |   <  __/
    |____/ \__,_|_|\_\___|
    

Warning: Keep the src\main\java folder as the root folder for Java files (i.e., don't rename those folders or move Java files to another folder outside of this folder path), as this is the default location some tools (e.g., Gradle) expect to find Java files.

Running Tests

The project comes with a set of test scripts for different operating systems:

  • MacOS/Linux: Run the shell script

    cd text-ui-test
    ./runtest.sh
  • Windows: Run the batch script

    cd text-ui-test
    runtest.bat

These scripts will compile the source files, run the tests, and compare the output against the expected output.

About

Starter code for CS2103DE individual project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 62.8%
  • Batchfile 30.8%
  • Java 6.4%