Setting up and getting started

Setting up the project on your computer

Caution: Follow the steps below precisely. The setup may fail if you skip or change a step.

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 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, follow the guide [se-edu/guides] Using Checkstyle to learn how to use Checkstyle in IDEA, for example to report problems as you write code.

  2. Set up CI

    This project includes GitHub Actions configuration files in .github/workflows. GitHub runs CI automatically for every push and pull request. No setup is required.

  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.

  4. Do the tutorials These tutorials will help you get acquainted with the codebase.