setting up environment

project: /appengine/docs/standard/_project.yaml

Setting up your development environment

Use the following steps to set up your local environment for developing and deploying your App Engine services:

1. Install the latest version of Go.

See Go runtime environment for a list of the supported versions.

1. 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.

1. Install the gcloud component that includes the App Engine extension for Go.

If you used the apt or yum package managers to install the gcloud CLI, use those same package managers to install the gcloud CLI component.

Otherwise, use the following command:

gcloud components install app-engine-go

Optional tools:

Install Git for access to code, samples, libraries, and tools in the Google Cloud GitHub repository.

1. Install the latest release of Java.

See Java runtime environment for a list of the supported versions.

1. 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.

1. Install the gcloud component that includes the App Engine extension for a supported Java version. If you used the apt or yum package managers to install the gcloud CLI, use those same package managers to install the gcloud CLI component.

Otherwise, use the following command:

gcloud components install app-engine-java

Optional tools:

• Install Git for access to code, samples, libraries, and tools in the Google Cloud GitHub repository. * Install tools. You can use the Maven or Gradle plugins to build, deploy, and manage your Java services:

  • Apache Maven and the App Engine Plugin
  • Gradle and the App Engine Plugin

  Note that you must also configure access for Cloud Build.

  When you deploy your services, Cloud Build is used to build each service into a container before that container is deployed to App Engine. Cloud Build does not have permission to deploy Java apps by default. After you create you Google Cloud project so you need to give Cloud Build permission to deploy your services to your Google Cloud project. Note that Cloud Build builds each container in the region where you create your project.

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.

Optional tools:

• Install Git for access to code, samples, libraries, and tools in the Google Cloud GitHub repository.
• 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.

Important: For the best experience on Windows, upgrade to the latest version of Node.js package manager (npm) by running npm install -g npm. The latest npm installs dependencies in a flat directory structure, so installations are unlikely to conflict with the Windows maximum path length of 255 characters. If you prefer to keep using an older version of npm, you can reduce the length of paths by moving your project to the root of your drive, for example, C:\ .

• Install nvm to easily manage your Node.js and npm installations.

If you use Windows, see nvm-windows.

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

1. Install the latest release of PHP.

See PHP runtime environment for a list of the supported versions.

1. 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.

Optional tools:

• Install Git for access to code, samples, libraries, and tools in the Google Cloud GitHub repository.
• To manage dependencies, download Composer and make sure the Composer executable is installed globally.

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.

Optional tools:

• Install Git for access to code, samples, libraries, and tools in the Google Cloud GitHub repository. * 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
  

1. Install the latest release of Python 3.

See Python 3 runtime environment for a list of the supported versions.

1. 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.

Optional tools:

• Install Git for access to code, samples, libraries, and tools in the Google Cloud GitHub repository.
• Install your preferred tooling or framework, for example you can use any of the following frameworks to develop your Python 3 app: * Flask * Django * Pyramid * Bottle * web.py * Tornado