Skip to content

Commit 325fd9c

Browse files
jmdobryjmdobry
committed
Merge pull request GoogleCloudPlatform#41 from GoogleCloudPlatform/readme
Added/clarified/corrected instructions.
2 parents 2b9ea17 + 28752dd commit 325fd9c

File tree

8 files changed

+88
-10
lines changed

8 files changed

+88
-10
lines changed

‎1-hello-world/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 1 - Hello world
2+
3+
This folder contains the sample code for the [Hello world][step-1]
4+
tutorial. Please refer to the tutorial for instructions on configuring, running,
5+
and deploying this sample.
6+
7+
[step-1]: https://cloud.google.com/nodejs/getting-started/hello-world

‎2-structured-data/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 2 - Structured data
2+
3+
This folder contains the sample code for the [Structured data][step-2]
4+
tutorial. Please refer to the tutorial for instructions on configuring, running,
5+
and deploying this sample.
6+
7+
[step-2]: https://cloud.google.com/nodejs/getting-started/using-structured-data

‎3-binary-data/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 3 - Cloud Storage
2+
3+
This folder contains the sample code for the [Cloud Storage][step-3]
4+
tutorial. Please refer to the tutorial for instructions on configuring, running,
5+
and deploying this sample.
6+
7+
[step-3]: https://cloud.google.com/nodejs/getting-started/using-cloud-storage

‎4-auth/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 4 - Authenticating users
2+
3+
This folder contains the sample code for the [Authenticating users][step-4]
4+
tutorial. Please refer to the tutorial for instructions on configuring, running,
5+
and deploying this sample.
6+
7+
[step-4]: https://cloud.google.com/nodejs/getting-started/authenticate-users

‎5-logging/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 5 - Logging app events
2+
3+
This folder contains the sample code for the [Logging app events][step-5]
4+
tutorial. Please refer to the tutorial for instructions on configuring, running,
5+
and deploying this sample.
6+
7+
[step-5]: https://cloud.google.com/nodejs/getting-started/logging-application-events

‎6-pubsub/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 6 - Using Cloud Pub/Sub
2+
3+
This folder contains the sample code for the [Using Cloud Pub/Sub][step-6]
4+
tutorial. Please refer to the tutorial for instructions on configuring, running,
5+
and deploying this sample.
6+
7+
[step-6]: https://cloud.google.com/nodejs/getting-started/using-pub-sub

‎7-gce/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 7 - Deploying to Google Compute Engine
2+
3+
This folder contains the sample code for the [Deploying to Google Compute Engine][step-7]
4+
tutorial. Please refer to the tutorial for instructions on configuring, running,
5+
and deploying this sample.
6+
7+
[step-7]: https://cloud.google.com/nodejs/getting-started/run-on-compute-engine

‎README.md‎

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,55 @@
11
# Getting started with Node.js on Google Cloud Platform
22

3-
[![Build Status](https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started.svg)](https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started)
3+
[![Build Status][travis-badge]][travis-link]
44

5-
This repository is the complete sample code for the [Node.js Getting Started on Google Cloud Platform](http://cloud.google.com/nodejs/getting-started) tutorials. Please refer to the tutorials for instructions on configuring, running, and deploying these samples.
5+
This repository contains the complete sample code for the
6+
[Node.js Getting Started on Google Cloud Platform][getting-started] tutorials.
7+
Please refer to the tutorials for instructions on configuring, running, and
8+
deploying these samples.
69

7-
The code for the samples is contained in individual branches on this repository.
10+
The code for each tutorial is in an individual folder in this repository.
811

912
Tutorial | Folder
1013
---------|-------
11-
[Hello world](https://cloud.google.com/nodejs/getting-started/hello-world) | [1-hello-world](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/1-hello-world)
12-
[Structured data](https://cloud.google.com/nodejs/getting-started/using-structured-data) | [2-structured-data](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/2-structured-data)
13-
[Cloud Storage](https://cloud.google.com/nodejs/getting-started/using-cloud-storage) | [3-binary-data](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/3-binary-data)
14-
[Authenticating users](https://cloud.google.com/nodejs/getting-started/authenticate-users) | [4-auth](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/4-auth)
15-
[Logging app events](https://cloud.google.com/nodejs/getting-started/logging-application-events) | [5-logging](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/5-logging)
16-
[Using Cloud Pub/Sub](https://cloud.google.com/nodejs/getting-started/using-pub-sub) | [6-pubsub](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/6-pubsub)
17-
[Deploying to Google Compute Engine](https://cloud.google.com/nodejs/getting-started/run-on-compute-engine) | [7-gce](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/7-gce)
14+
[Hello world][step-1] | [1-hello-world][step-1-code]
15+
[Structured data][step-2] | [2-structured-data][step-2-code]
16+
[Cloud Storage][step-3] | [3-binary-data][step-3-code]
17+
[Authenticating users][step-4] | [4-auth][step-4-code]
18+
[Logging app events][step-5] | [5-logging][step-5-code]
19+
[Using Cloud Pub/Sub][step-6] | [6-pubsub][step-6-code]
20+
[Deploying to Google Compute Engine][step-7] | [7-gce][step-7-code]
1821

1922
## Contributing changes
2023

2124
* See [CONTRIBUTING.md](CONTRIBUTING.md)
2225

26+
### Run the tests
27+
28+
* Make sure you're authenticated with the gcloud sdk and your gcloud project
29+
has enabled all the APIs used by these tutorials.
30+
* `git clone git@github.com:GoogleCloudPlatform/nodejs-getting-started.git`
31+
* `cd nodejs-getting-started`
32+
* `npm install`
33+
* `npm test`
2334

2435
## Licensing
2536

2637
* See [LICENSE](LICENSE)
38+
39+
[travis-badge]: https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started.svg
40+
[travis-link]: https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started
41+
[getting-started]: http://cloud.google.com/nodejs/getting-started
42+
[step-1]: https://cloud.google.com/nodejs/getting-started/hello-world
43+
[step-1-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/1-hello-world
44+
[step-2]: https://cloud.google.com/nodejs/getting-started/using-structured-data
45+
[step-2-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/2-structured-data
46+
[step-3]: https://cloud.google.com/nodejs/getting-started/using-cloud-storage
47+
[step-3-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/3-binary-data
48+
[step-4]: https://cloud.google.com/nodejs/getting-started/authenticate-users
49+
[step-4-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/4-auth
50+
[step-5]: https://cloud.google.com/nodejs/getting-started/logging-application-events
51+
[step-5-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/5-logging
52+
[step-6]: https://cloud.google.com/nodejs/getting-started/using-pub-sub
53+
[step-6-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/6-pubsub
54+
[step-7]: https://cloud.google.com/nodejs/getting-started/run-on-compute-engine
55+
[step-7-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/7-gce

0 commit comments

Comments
 (0)