Set up IntelliJ from scratch

Start here if you are setting up a brand new development environment, or want to reconfigure your environment from scratch.

The instructions below assume you already have available:xgdfg

• A recent version of IntelliJ. These steps have been validated on IntelliJ 2019.1 with Beam 2.14-SNAPSHOT

• JDK 1.8 installed and configured in IntelliJ

• A local git clone of the apache/beam repository in your home directory ("~/beam")

To set up your IntelliJ project:

1. Launch the New Project wizard by selecting File | New | Project.

2. In the New Project wizard, select Empty Project and click Next.

3. Name your project "beam" and choose a location outside of the source tree, i.e. "~/IdeaProjects/beam". Don't change any other settings, and select Finish.

This will create the initial project and bring up the Project Structure settings.

1. In the Project pane, set the Project SDK to "1.8", and select Apply.

2. In the Modules pane, click the + and select Import Module. Select your beam repository ("~/beam") and select OK.

3. In the Import Module wizard, select Import module from external model, then select Gradle. Then select Next.

4. On the next screen, ensure that Create separate module per source set and Use default gradle wrapper (recommended) are selected, and keep the rest of the default values. Then select Finish.
   

5. In the Problems pane, ensure there are no issues listed, then select Apply and OK.

This will close the wizard and cause IntelliJ to begin syncing project structure in the background. Continue configuring the IDE while the project syncs:

1. Open File | Settings... In left pane, navigate to Build, Execution, Deployment | Build Tools | Gradle | Runner. Select Delegate IDE build/run actions to gradle, and Run tests using: Gradle Test Runner. Then select Apply and OK.
   
   

2. Open View | Tool Windows | Gradle to open the Gradle pane.

Wait for the Gradle project to sync-- it may take 30 minutes or more. It should complete with no errors, and populate the list of Gradle projects in the Gradle pane.

Verify that your project is correctly configured by building and testing a single module.

You may also want to setup a specialized environment for the Beam modules you're working on: