IntelliJ IDEA 2023.3 Help

App Engine

Google App Engine is a service and a platform where you can develop and host web applications. You can learn more about Google App Engine at the official Google App Engine site.

With App Engine integration, you can run and debug Google App Engine applications. A new project already includes app.yaml with default configuration settings, and the GO file with the Hello World application. Customize the basic handler in the GO file or write your own.

The App Engine project has a predefined run/debug configuration. To add another configuration, select Go build in the Run/Debug configurations dialog. For more information about run/debug configurations, refer to Run/debug configurations.

Create a project with App Engine integration

  1. Select File | New | New Project.

    Alternatively, click New Project in the Welcome to IntelliJ IDEA dialog.

  2. In the New Project dialog, select App Engine from the list of available projects.

  3. In the GOROOT field, specify the location of your Go installation. Usually, the location is defined automatically.

    To change or install a new version of Go SDK, click the Add SDK… button and select Local… to choose the Go SDK version on your hard drive, or select Download… to download Go SDK from the official repository.

  4. (Optional) Toggle the Index entire GOPATH checkbox:

    • When cleared, project files and vendored packages are indexed. Packages from GOPATH are not indexed. Might improve the overall performance.

    • When selected, packages from GOPATH and project files are indexed.

  5. Click Next, specify a project name and click Finish.

    Create a project with App Engine integration

Working with App Engine applications

As you created an App Engine project, you can start debugging. The App Engine project has a predefined run/debug configuration and the default address (http://localhost:8080).

Run an App Engine application

  1. Click Run | Edit Configurations.

  2. Click the Add button (The Add button) and select Go Build.

  3. From the Run kind list, select Directory.

    Run Debug Configuration For App Engine
  4. Click OK.

  5. Press Ctrl+Shift+F10. Alternatively, right-click any area of the opened file in the editor and select Run <configuration_name>.

  6. In the Run tool window on the App Engine tab, click the server address.

    Run the Google App engine application

Debug an App Engine application

  1. Click in the gutter where you want to set a breakpoint. For more information about breakpoints, refer to Breakpoints.

  2. Press Shift+F9. Alternatively, right-click any area of the opened file in the editor and select Debug <configuration_name>.

    In the Debug tool window, refer to a list of frames that you can inspect. You can click the frame to view the current state of variables.

    Debug App Engine applications

Installing Go SDK

Select a local copy of the Go SDK

  1. Press Ctrl+Alt+S to open the IDE settings and then select Languages & Frameworks | Go | GOROOT.

  2. Click the Add SDK button (the Add SDK button) and select Local….

  3. In the file browser, navigate to the SDK version that is on your hard drive.

  4. Click Open.

    Installing Go SDK

Download the Go SDK

  1. Press Ctrl+Alt+S to open the IDE settings and then select Languages & Frameworks | Go | GOROOT.

  2. Click the Add SDK button (the Add SDK button) and select Download….

  3. From the Version list, select the SDK version.

  4. In the Location field, specify the path for the SDK. To use a file browser, click the Browse icon (the Browse icon).

  5. Click OK.

    Installing Go SDK
Last modified: 19 March 2024