Skip to content

Commit 0d142dd

Browse files
tswasttswast
committed
Merge pull request #152 from GoogleCloudPlatform/appengine-readme
Improve READMEs for App Engine samples.
2 parents 2e672da + cac05d5 commit 0d142dd

File tree

9 files changed

+240
-35
lines changed

9 files changed

+240
-35
lines changed

‎appengine/README.md

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Google App Engine Standard Environment Java Samples
2+
3+
This is a repository that contains Java code samples for [Google App Engine
4+
standard environment][ae-docs].
5+
6+
[ae-docs]: https://cloud.google.com/appengine/docs/java/
7+
8+
## Prerequisites
9+
10+
### Download Maven
11+
12+
These samples use the [Apache Maven][maven] build system. Before getting
13+
started, be sure to [download][maven-download] and [install][maven-install] it.
14+
When you use Maven as described here, it will automatically download the needed
15+
client libraries.
16+
17+
[maven]: https://maven.apache.org
18+
[maven-download]: https://maven.apache.org/download.cgi
19+
[maven-install]: https://maven.apache.org/install.html
20+
21+
### Create a Project in the Google Cloud Platform Console
22+
23+
If you haven't already created a project, create one now. Projects enable you to
24+
manage all Google Cloud Platform resources for your app, including deployment,
25+
access control, billing, and services.
26+
27+
1. Open the [Cloud Platform Console][cloud-console].
28+
1. In the drop-down menu at the top, select **Create a project**.
29+
1. Give your project a name.
30+
1. Make a note of the project ID, which might be different from the project
31+
name. The project ID is used in commands and in configurations.
32+
33+
[cloud-console]: https://console.cloud.google.com/
34+
35+
36+
## Samples
37+
38+
### Hello World
39+
40+
This sample demonstrates how to deploy an application on Google App Engine.
41+
42+
- [Documentation][ae-docs]
43+
- [Code](helloworld)
44+
45+
### Sending Email
46+
47+
#### Sending Email with Mailgun
48+
49+
This sample demonstrates how to send email using the [Mailgun API][mailgun-api].
50+
51+
- [Documentation][mailgun-sample-docs]
52+
- [Code](mailgun)
53+
54+
[mailgun-api]: https://documentation.mailgun.com/
55+
[mailgun-sample-docs]: https://cloud.google.com/appengine/docs/java/mail/mailgun
56+
57+
#### Sending Email with SendGrid
58+
59+
This sample demonstrates how to send email using the [SendGrid][sendgrid].
60+
61+
- [Documentation][sendgrid-sample-docs]
62+
- [Code](sendgrid)
63+
64+
[sendgrid]: https://sendgrid.com/docs/User_Guide/index.html
65+
[sendgrid-sample-docs]: https://cloud.google.com/appengine/docs/java/mail/sendgrid
66+
67+
### Sending SMS with Twilio
68+
69+
This sample demonstrates how to use [Twilio](https://www.twilio.com) on [Google
70+
App Engine standard environment][ae-docs].
71+
72+
- [Documentation][twilio-sample-docs]
73+
- [Code](twilio)
74+
75+
[twilio-sample-docs]: https://cloud.google.com/appengine/docs/java/sms/twilio
76+
77+
### App Identity
78+
79+
This sample demonstrates how to use the [App Identity API][appid] to discover
80+
the application's ID and assert identity to Google and third-party APIs.
81+
82+
- [Documentation][appid]
83+
- [Code](appidentity)
84+
85+
[appid]: https://cloud.google.com/appengine/docs/java/appidentity/
86+
87+
### Other Samples
88+
89+
- [Sample Applications][sample-apps]
90+
91+
[sample-apps]: https://cloud.google.com/appengine/docs/java/samples
92+
93+
94+
## Contributing changes
95+
96+
See [CONTRIBUTING.md](../CONTRIBUTING.md).
97+
98+
## Licensing
99+
100+
See [LICENSE](../LICENSE).
101+

‎appengine/appidentity/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# App Identity sample for Google App Engine
2-
This sample demonstrates how to use the App Identity APIs on Google App Engine
2+
3+
This sample demonstrates how to use the [App Identity API][appid] on [Google App
4+
Engine][ae-docs].
5+
6+
[appid]: https://cloud.google.com/appengine/docs/java/appidentity/
7+
[ae-docs]: https://cloud.google.com/appengine/docs/java/
38

49
## Running locally
510
This example uses the

‎appengine/helloworld/README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# Appengine Helloworld sample for Google App Engine
2-
This sample demonstrates how to deploy an application on Google App Engine
1+
# Google App Engine Standard Environment Hello World Sample
2+
3+
This sample demonstrates how to deploy an application on Google App Engine.
4+
5+
See the [Google App Engine standard environment documentation][ae-docs] for more
6+
detailed instructions.
7+
8+
[ae-docs]: https://cloud.google.com/appengine/docs/java/
9+
310
## Setup
4-
1. Update the <application> tag in src/main/webapp/WEB-INF/appengine-web.xml with your project name
5-
1. Update the <version> tag in src/main/webapp/WEB-INF/appengine-web.xml with your version name
11+
1. Update the `<application>` tag in `src/main/webapp/WEB-INF/appengine-web.xml`
12+
with your project name.
13+
1. Update the `<version>` tag in `src/main/webapp/WEB-INF/appengine-web.xml`
14+
with your version name.
615

716
## Running locally
817
$ mvn appengine:devserver

‎appengine/mailgun/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Java Mailgun Email Sample for Google App Engine Standard Environment
2+
3+
This sample demonstrates how to use [Mailgun][mailgun-api] on [Google App Engine
4+
standard environment][ae-docs].
5+
6+
See the [sample application documentaion][sample-docs] for more detailed
7+
instructions.
8+
9+
[ae-docs]: https://cloud.google.com/appengine/docs/java/
10+
[mailgun-api]: https://documentation.mailgun.com/
11+
[sample-docs]: https://cloud.google.com/appengine/docs/java/mail/mailgun

‎appengine/sendgrid/README.md

+23-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
1-
# Java SendGrid email sample for Google Managed VMs
2-
This sample demonstrates how to use [SendGrid](https://www.sendgrid.com) on Google Managed VMs
3-
For more information about SendGrid, see their [documentation](https://sendgrid.com/docs/User_Guide/index.html).
1+
# Java SendGrid Email Sample for Google App Engine Standard Environment
2+
3+
This sample demonstrates how to use [SendGrid](https://www.sendgrid.com) on
4+
[Google App Engine standard environment][ae-docs].
5+
6+
See the [sample application documentaion][sample-docs] for more detailed
7+
instructions.
8+
9+
For more information about SendGrid, see their
10+
[documentation](https://sendgrid.com/docs/User_Guide/index.html).
11+
12+
[ae-docs]: https://cloud.google.com/appengine/docs/java/
13+
[sample-docs]: https://cloud.google.com/appengine/docs/java/mail/sendgrid
14+
415
## Setup
16+
517
Before you can run or deploy the sample, you will need to do the following:
6-
1. [Create a SendGrid Account](http://sendgrid.com/partner/google). As of September 2015, Google users start with 25,000 free emails per month.
7-
1. Configure your SendGrid settings in the environment variables section in ``src/main/appengine/app.yaml``.
18+
19+
1. [Create a SendGrid Account](http://sendgrid.com/partner/google). As of
20+
September 2015, Google users start with 25,000 free emails per month.
21+
1. Configure your SendGrid settings in the environment variables section in
22+
[`src/main/webapp/WEB-INF/appengine-web.xml`](src/main/webapp/WEB-INF/appengine-web.xml).
23+
824
## Running locally
25+
926
You can run the application locally and send emails from your local machine. You
1027
will need to set environment variables before starting your application:
28+
1129
$ export SENDGRID_API_KEY=[your-sendgrid-api-key]
1230
$ export SENDGRID_SENDER=[your-sendgrid-sender-email-address]
1331
$ mvn clean jetty:run

‎appengine/twilio/README.md

+28-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
1-
# Java Twilio voice and SMS sample for Google Managed VMs
2-
This sample demonstrates how to use [Twilio](https://www.twilio.com) on Google Managed VMs
3-
For more information about Twilio, see their [Java quickstart tutorials](https://www.twilio.com/docs/quickstart/java).
1+
# Java Twilio Voice and SMS Sample for Google App Engine Standard Environment
2+
3+
This sample demonstrates how to use [Twilio](https://www.twilio.com) on [Google
4+
App Engine standard environment][ae-docs].
5+
6+
See the [sample application documentaion][sample-docs] for more detailed
7+
instructions.
8+
9+
For more information about Twilio, see their [Java quickstart
10+
tutorials](https://www.twilio.com/docs/quickstart/java).
11+
12+
[ae-docs]: https://cloud.google.com/appengine/docs/java/
13+
[sample-docs]: https://cloud.google.com/appengine/docs/java/sms/twilio
14+
15+
416
## Setup
17+
518
Before you can run or deploy the sample, you will need to do the following:
6-
1. [Create a Twilio Account](http://ahoy.twilio.com/googlecloudplatform). Google App Engine
7-
customers receive a complimentary credit for SMS messages and inbound messages.
8-
1. Create a number on twilio, and configure the voice request URL to be ``https://your-app-id.appspot.com/call/receive``
9-
and the SMS request URL to be ``https://your-app-id.appspot.com/sms/receive``.
10-
1. Configure your Twilio settings in the environment variables section in ``src/main/appengine/app.yaml``.
19+
20+
1. [Create a Twilio Account](http://ahoy.twilio.com/googlecloudplatform). Google
21+
App Engine customers receive a complimentary credit for SMS messages and
22+
inbound messages.
23+
1. Create a number on twilio, and configure the voice request URL to be
24+
``https://your-app-id.appspot.com/call/receive`` and the SMS request URL to
25+
be ``https://your-app-id.appspot.com/sms/receive``.
26+
1. Configure your Twilio settings in the environment variables section in
27+
[`src/main/webapp/WEB-INF/appengine-web.xml`](src/main/webapp/WEB-INF/appengine-web.xml).
28+
1129
## Running locally
30+
1231
You can run the application locally to test the callbacks and SMS sending. You
1332
will need to set environment variables before starting your application:
33+
1434
$ export TWILIO_ACCOUNT_SID=[your-twilio-accoun-sid]
1535
$ export TWILIO_AUTH_TOKEN=[your-twilio-auth-token]
1636
$ export TWILIO_NUMBER=[your-twilio-number]

‎managed_vms/README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
## Google Managed VMs Java Samples
1+
# Google App Engine Flexible Environment Java Samples
22

3-
This is a repository that contains Java code samples for Google Managed VMs
3+
This is a repository that contains Java code samples for [Google App Engine
4+
flexible environment][aeflex-docs].
45

5-
See our other [Google Cloud Platform github
6+
See our other [Google Cloud Platform GitHub
67
repos](https://github.com/GoogleCloudPlatform) for sample applications and
78
scaffolding for other frameworks and use cases.
89

10+
[aeflex-docs]: https://cloud.google.com/appengine/docs/flexible/
11+
912
## Run Locally
1013
1. Install the [Google Cloud SDK](https://cloud.google.com/sdk/), including the [gcloud tool](https://cloud.google.com/sdk/gcloud/), and [gcloud app component](https://cloud.google.com/sdk/gcloud-app).
1114
1. Setup the gcloud tool.
@@ -17,7 +20,7 @@ scaffolding for other frameworks and use cases.
1720
1. Clone this repo.
1821

1922
```
20-
git clone https://github.com/GoogleCloudPlatform/<REPO NAME>.git
23+
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
2124
```
2225

2326
1. Run this project locally from the command line.

‎managed_vms/sendgrid/README.md

+23-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
1-
# Java SendGrid email sample for Google Managed VMs
2-
This sample demonstrates how to use [SendGrid](https://www.sendgrid.com) on Google Managed VMs
3-
For more information about SendGrid, see their [documentation](https://sendgrid.com/docs/User_Guide/index.html).
1+
# Java SendGrid Email Sample for Google App Engine Flexible Environment
2+
3+
This sample demonstrates how to use [SendGrid](https://www.sendgrid.com) on
4+
[Google App Engine flexible environment][aeflex-docs].
5+
6+
See the [sample application documentaion][sample-docs] for more detailed
7+
instructions.
8+
9+
For more information about SendGrid, see their
10+
[documentation](https://sendgrid.com/docs/User_Guide/index.html).
11+
12+
[aeflex-docs]: https://cloud.google.com/appengine/docs/flexible/
13+
[sample-docs]: https://cloud.google.com/appengine/docs/flexible/java/sending-emails-with-sendgrid
14+
415
## Setup
16+
517
Before you can run or deploy the sample, you will need to do the following:
6-
1. [Create a SendGrid Account](http://sendgrid.com/partner/google). As of September 2015, Google users start with 25,000 free emails per month.
7-
1. Configure your SendGrid settings in the environment variables section in ``src/main/appengine/app.yaml``.
18+
19+
1. [Create a SendGrid Account](http://sendgrid.com/partner/google). As of
20+
September 2015, Google users start with 25,000 free emails per month.
21+
1. Configure your SendGrid settings in the environment variables section in
22+
[`src/main/appengine/app.yaml`](src/main/appengine/app.yaml).
23+
824
## Running locally
25+
926
You can run the application locally and send emails from your local machine. You
1027
will need to set environment variables before starting your application:
28+
1129
$ export SENDGRID_API_KEY=[your-sendgrid-api-key]
1230
$ export SENDGRID_SENDER=[your-sendgrid-sender-email-address]
1331
$ mvn clean jetty:run

‎managed_vms/twilio/README.md

+28-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
1-
# Java Twilio voice and SMS sample for Google Managed VMs
2-
This sample demonstrates how to use [Twilio](https://www.twilio.com) on Google Managed VMs
3-
For more information about Twilio, see their [Java quickstart tutorials](https://www.twilio.com/docs/quickstart/java).
1+
# Java Twilio Voice and SMS Sample for Google App Engine Flexible Environment
2+
3+
This sample demonstrates how to use [Twilio](https://www.twilio.com) on [Google
4+
App flexible environment][aeflex-docs].
5+
6+
See the [sample application documentaion][sample-docs] for more detailed
7+
instructions.
8+
9+
For more information about Twilio, see their [Java quickstart
10+
tutorials](https://www.twilio.com/docs/quickstart/java).
11+
12+
[aeflex-docs]: https://cloud.google.com/appengine/docs/flexible/
13+
[sample-docs]: https://cloud.google.com/appengine/docs/flexible/java/using-sms-and-voice-services-via-twilio
14+
15+
416
## Setup
17+
518
Before you can run or deploy the sample, you will need to do the following:
6-
1. [Create a Twilio Account](http://ahoy.twilio.com/googlecloudplatform). Google App Engine
7-
customers receive a complimentary credit for SMS messages and inbound messages.
8-
1. Create a number on twilio, and configure the voice request URL to be ``https://your-app-id.appspot.com/call/receive``
9-
and the SMS request URL to be ``https://your-app-id.appspot.com/sms/receive``.
10-
1. Configure your Twilio settings in the environment variables section in ``src/main/appengine/app.yaml``.
19+
20+
1. [Create a Twilio Account](http://ahoy.twilio.com/googlecloudplatform). Google
21+
App Engine customers receive a complimentary credit for SMS messages and
22+
inbound messages.
23+
1. Create a number on twilio, and configure the voice request URL to be
24+
``https://your-app-id.appspot.com/call/receive`` and the SMS request URL to
25+
be ``https://your-app-id.appspot.com/sms/receive``.
26+
1. Configure your Twilio settings in the environment variables section in
27+
``src/main/appengine/app.yaml``.
28+
1129
## Running locally
30+
1231
You can run the application locally to test the callbacks and SMS sending. You
1332
will need to set environment variables before starting your application:
33+
1434
$ export TWILIO_ACCOUNT_SID=[your-twilio-accoun-sid]
1535
$ export TWILIO_AUTH_TOKEN=[your-twilio-auth-token]
1636
$ export TWILIO_NUMBER=[your-twilio-number]

0 commit comments

Comments
 (0)