Setting up and getting started

Setting up the project in your computer

Caution: Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.

First, fork this repo, and clone the fork into your computer.

If you plan to use Intellij IDEA (highly recommended):

  1. Configure the JDK: Follow the guide [se-edu/guides] IDEA: Configuring the JDK to ensure Intellij is configured to use JDK 17.
  2. Import the project as a Gradle project: Follow the guide [se-edu/guides] IDEA: Importing a Gradle project to import the project into IDEA.
    Note: Importing a Gradle project is slightly different from importing a normal Java project.
  3. Verify the setup:
    1. Run the seedu.address.Main and try a few commands.
    2. Run the tests to ensure they all pass.

Before writing code

  1. Configure the coding style

    If using IDEA, follow the guide [se-edu/guides] IDEA: Configuring the code style to set up IDEA's coding style to match ours.

    Tip: Optionally, you can follow the guide [se-edu/guides] Using Checkstyle to find how to use the CheckStyle within IDEA e.g., to report problems as you write code.

  2. Set up CI

    This project comes with a GitHub Actions config files (in .github/workflows folder). The files are set up to automate the workflows of testing through CI whenever any push to the master or PR is made.

  3. Learn the design

    When you are ready to start coding, we recommend that you get some sense of the overall design by reading about AddressBook’s architecture, given that KrustyKrab is based off AddressBook-Level3.

  4. Do the tutorials These tutorials will help you get acquainted with the AddressBook-Level3 codebase, and provide familiarity with our application.