Setting up and getting started

🖥️ Setting up the project on your computer

Caution: Follow the steps below precisely. Setup may fail if instructions are skipped or altered.

  1. Fork this repository on GitHub, then clone your fork to your computer.

  2. If you’re using IntelliJ IDEA (highly recommended):

    1. Configure the JDK Use this guide to set up JDK 17 in IntelliJ.

    2. Import as a Gradle Project Follow this guide.

      ⚠️ Note: Importing a Gradle project is slightly different from a normal Java project.

    3. Verify the Setup

      • Run the app using MainApp.java (entry point: seedu.address.Main)
      • Run the tests: ./gradlew test or open the Testing.md for guidance
      • You should see the GUI and be able to enter commands like list, add, or task

🛠️ Before Writing Code

1. Configure the Coding Style

  • Follow this guide to align with the project’s Java formatting rules.
đź’ˇ Optionally, install Checkstyle in IntelliJ and configure it using [this guide](https://se-education.org/guides/tutorials/checkstyle.html) for real-time style checking.

2. CI/CD Setup (Auto-configured)

TeamScape uses GitHub Actions for CI. Configuration files are in .github/workflows. CI will automatically run on each push or pull request. No extra setup is required.

3. Learn the Design

Once setup is complete, we recommend familiarizing yourself with TeamScape's overall design:

📖 See: Developer Guide → Architecture

4. Do the Tutorials

These tutorials will help you understand how TeamScape (originally AB3) works:

🔄 You can adapt these tutorials to your custom commands like task, mark, or setduedate.