Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products. If you have feedback or questions as you navigate the site, click Send Feedback.

Setting up your development environment

Stay organized with collections Save and categorize content based on your preferences.

Go

To set up your environment for developing on Go 1.12+:

  1. Install the latest release of Go 1.12+.

    See Go 1.12+ Runtime Environment for a list of the supported versions.

  2. Install and initialize the gcloud CLI for deploying and managing your apps. If you already have the gcloud CLI installed and initialized, run the gcloud components update command to update to the latest release.

    By downloading, you agree to be bound by the Terms that govern use of the gcloud CLI for App Engine.

  3. Install the gcloud component that includes the App Engine extension for Go 1.12+. If you used the apt or yum package managers to install the gcloud CLI, use those same package managers to install the gcloud component.

    Otherwise, use the following command:

    gcloud components install app-engine-go

Installing optional tools

  • For access to code, samples, libraries, and tools in GitHub, install Git:

    Install Git

Java

To set up your environment for developing on Java 11/17:

  1. Install the latest release of Java 11/17.

    See Java 11/17 Runtime Environment for a list of the supported versions.

  2. Install and initialize the gcloud CLI for deploying and managing your apps. If you already have the gcloud CLI installed and initialized, run the gcloud components update command to update to the latest release.

    By downloading, you agree to be bound by the Terms that govern use of the gcloud CLI for App Engine.

  3. Install the gcloud component that includes the App Engine extension for Java 11/17. If you used the apt or yum package managers to install the gcloud CLI, use those same package managers to install the gcloud component.

    Otherwise, use the following command:

    gcloud components install app-engine-java

Installing optional tools

Give permission to Cloud Build

When you deploy your app, App Engine uses Cloud Build to build the app into a container and deploy the container to the runtime. Cloud Build does not have permission to deploy Java 11/17 apps by default, so you need to give Cloud Build permission to deploy apps in your project. The builds are created in the app's region.

Node.js

To set up your environment for developing on Node.js:

  1. Install the latest release of Node.js. See Node.js Runtime Environment for a list of the supported versions.

  2. Install and initialize the gcloud CLI for deploying and managing your apps. If you already have the gcloud CLI installed and initialized, run the gcloud components update command to update to the latest release.

    By downloading, you agree to be bound by the Terms that govern use of the gcloud CLI for App Engine.

Installing optional tools

  • For access to code, samples, libraries, and tools in GitHub, install Git:

    Install Git

  • The npm package manager is usually installed alongside Node.js, but you also have the option to install the Yarn package manager as an alternative.

  • To easily manage your Node.js and npm installations, install Node Version Manager (nvm): Install nvm

    If you use Windows, see nvm-windows.

  • Install your preferred tooling or framework, for example you can use the Express.js framework.

PHP

To set up your environment for developing on PHP 7+:

  1. Install the latest release of PHP 7+.

    See PHP 7+ Runtime Environment for a list of the supported versions.

  2. Install and initialize the gcloud CLI for deploying and managing your apps. If you already have the gcloud CLI installed and initialized, run the gcloud components update command to update to the latest release.

    By downloading, you agree to be bound by the Terms that govern use of the gcloud CLI for App Engine.

Installing optional tools

Python

To set up your environment for developing on Python 3:

  1. Install the latest release of Python 3.

    See Python3 Runtime Environment for a list of the supported versions.

  2. Install and initialize the gcloud CLI for deploying and managing your apps. If you already have the gcloud CLI installed and initialized, run the gcloud components update command to update to the latest release. By downloading, you agree to be bound by the Terms that govern use of the gcloud CLI for App Engine.

Installing optional tools

Ruby

To set up your environment for developing on Ruby:

  1. Install the latest release of Ruby. See Ruby Runtime Environment for a list of the supported versions.
  2. Install and initialize the gcloud CLI for deploying and managing your apps. If you already have the gcloud CLI installed and initialized, run the gcloud components update command to update to the latest release.

    By downloading, you agree to be bound by the Terms that govern use of the gcloud CLI for App Engine.

Installing optional tools

  • For access to code, samples, libraries, and tools in GitHub, install Git:

    Install Git

  • Install your preferred tooling or framework, for example the Sinatra or Ruby on Rails frameworks.
  • To easily manage your Ruby dependencies, install Bundler:

    gem install bundler