This quickstart shows you how to create a small App Engine application that displays a short message.
Before running this sample, take the following steps:
Use the Cloud Platform Console to create a new Cloud Platform project,
create an App Engine application, and enable billing:
to App Engine
When prompted, select the region where you want your App Engine application located and then enable billing.
- Install the following prerequisites locally:
- Alternatively: You can use Google Cloud Shell, which comes with git and Cloud SDK already installed, and many other features, such as language support and code editors. Once your Google Cloud Shell is launched, you can proceed with the rest of this tutorial and execute your commands within your Cloud Shell.
Download the Hello World app
We've created a simple Hello World app for Ruby so you can quickly get a feel for deploying an app to Google Cloud Platform. Follow these steps from a command line to download Hello World to your local machine.
Download the sample app and navigate into the app directory:
Clone the Hello World sample app repository to your local machine:
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
Alternatively, you can download the sample as a zip file and extract it.
Change to the directory that contains the sample code:
Run Hello World on your local machine
To run the Hello World app on your local computer:
Install dependencies for this project by entering the following command:
Start a local web server:
bundle exec ruby app.rb -p 8080
In your web browser, enter the following address:
You can see the Hello World message from the sample app displayed in the page.
In your terminal window, press Ctrl+C to exit the web server.
Deploy and run Hello World on App Engine
To deploy your app to the App Engine flexible environment:
- Deploy the Hello World app by running the following
gcloud app deploy
- Visit the following address to see your deployed app:
This time, the page that displays the Hello World message is delivered by a web server running on an App Engine instance.
Congratulations! You've deployed your first Ruby app to App Engine flexible environment!
To avoid incurring charges to your Cloud Platform project project, you can delete your project to stop billing for all resources within the project.
- In the Cloud Platform Console, go to the Projects page.
- In the project list, select the project you want to delete and click Delete project.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Learn the whole platform
Now that you know what it's like to develop and deploy App Engine apps, you can stretch out and see the rest of Google Cloud Platform. You already have the Google Cloud SDK installed and that gives you the tools to interact with products like Google Cloud SQL, Google Cloud Storage, Google Cloud Datastore, and more. For a guided walkthrough that teaches you how to create an application that uses the entire platform, not just App Engine, check out our quickstart on creating the Bookshelf app.
Learn about the App Engine flexible environment
Here are some topics to help continue your learning about App Engine.
- An Overview of App Engine
- How Requests are Routed
- How Requests are Handled
- How Instances are Managed
Hello World code review
Hello World is the simplest possible App Engine app, as it contains only one service, has only one version, and all of the code is located within the app's root directory. This section describes each of the app files in detail.
The Hello World app is a very basic one-file Sinatra application:
require "sinatra" get "/" do "Hello world!" end
file describes an application's deployment configuration:
runtime: ruby env: flex entrypoint: bundle exec ruby app.rb -p $PORT
app.yamlspecifies the runtime used by the app, and sets
env: flex, specifying that the app uses the flexible environment.
For more information on how the Ruby runtime works, see The Ruby Runtime.
For more details about how to design your app to take advantage of versions and services, see An Overview of App Engine.
For more details about the configuration settings for App Engine, see Configuring Your App with app.yaml.
is used to specify the application's
is used to declare and install dependencies. The Hello World application
requires one Ruby gem: the
source "https://rubygems.org" gem "sinatra"