forked from GoogleCloudPlatform/nodejs-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request GoogleCloudPlatform#41 from GoogleCloudPlatform/re…
…adme Added/clarified/corrected instructions.
- Loading branch information
Showing
8 changed files
with
88 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 1 - Hello world | ||
|
||
This folder contains the sample code for the [Hello world][step-1] | ||
tutorial. Please refer to the tutorial for instructions on configuring, running, | ||
and deploying this sample. | ||
|
||
[step-1]: https://cloud.google.com/nodejs/getting-started/hello-world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 2 - Structured data | ||
|
||
This folder contains the sample code for the [Structured data][step-2] | ||
tutorial. Please refer to the tutorial for instructions on configuring, running, | ||
and deploying this sample. | ||
|
||
[step-2]: https://cloud.google.com/nodejs/getting-started/using-structured-data |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 3 - Cloud Storage | ||
|
||
This folder contains the sample code for the [Cloud Storage][step-3] | ||
tutorial. Please refer to the tutorial for instructions on configuring, running, | ||
and deploying this sample. | ||
|
||
[step-3]: https://cloud.google.com/nodejs/getting-started/using-cloud-storage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 4 - Authenticating users | ||
|
||
This folder contains the sample code for the [Authenticating users][step-4] | ||
tutorial. Please refer to the tutorial for instructions on configuring, running, | ||
and deploying this sample. | ||
|
||
[step-4]: https://cloud.google.com/nodejs/getting-started/authenticate-users |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 5 - Logging app events | ||
|
||
This folder contains the sample code for the [Logging app events][step-5] | ||
tutorial. Please refer to the tutorial for instructions on configuring, running, | ||
and deploying this sample. | ||
|
||
[step-5]: https://cloud.google.com/nodejs/getting-started/logging-application-events |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 6 - Using Cloud Pub/Sub | ||
|
||
This folder contains the sample code for the [Using Cloud Pub/Sub][step-6] | ||
tutorial. Please refer to the tutorial for instructions on configuring, running, | ||
and deploying this sample. | ||
|
||
[step-6]: https://cloud.google.com/nodejs/getting-started/using-pub-sub |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 7 - Deploying to Google Compute Engine | ||
|
||
This folder contains the sample code for the [Deploying to Google Compute Engine][step-7] | ||
tutorial. Please refer to the tutorial for instructions on configuring, running, | ||
and deploying this sample. | ||
|
||
[step-7]: https://cloud.google.com/nodejs/getting-started/run-on-compute-engine |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,55 @@ | ||
# Getting started with Node.js on Google Cloud Platform | ||
|
||
[![Build Status](https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started.svg)](https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started) | ||
[![Build Status][travis-badge]][travis-link] | ||
|
||
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. | ||
This repository contains the complete sample code for the | ||
[Node.js Getting Started on Google Cloud Platform][getting-started] tutorials. | ||
Please refer to the tutorials for instructions on configuring, running, and | ||
deploying these samples. | ||
|
||
The code for the samples is contained in individual branches on this repository. | ||
The code for each tutorial is in an individual folder in this repository. | ||
|
||
Tutorial | Folder | ||
---------|------- | ||
[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) | ||
[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) | ||
[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) | ||
[Authenticating users](https://cloud.google.com/nodejs/getting-started/authenticate-users) | [4-auth](https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/4-auth) | ||
[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) | ||
[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) | ||
[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) | ||
[Hello world][step-1] | [1-hello-world][step-1-code] | ||
[Structured data][step-2] | [2-structured-data][step-2-code] | ||
[Cloud Storage][step-3] | [3-binary-data][step-3-code] | ||
[Authenticating users][step-4] | [4-auth][step-4-code] | ||
[Logging app events][step-5] | [5-logging][step-5-code] | ||
[Using Cloud Pub/Sub][step-6] | [6-pubsub][step-6-code] | ||
[Deploying to Google Compute Engine][step-7] | [7-gce][step-7-code] | ||
|
||
## Contributing changes | ||
|
||
* See [CONTRIBUTING.md](CONTRIBUTING.md) | ||
|
||
### Run the tests | ||
|
||
* Make sure you're authenticated with the gcloud sdk and your gcloud project | ||
has enabled all the APIs used by these tutorials. | ||
* `git clone git@github.com:GoogleCloudPlatform/nodejs-getting-started.git` | ||
* `cd nodejs-getting-started` | ||
* `npm install` | ||
* `npm test` | ||
|
||
## Licensing | ||
|
||
* See [LICENSE](LICENSE) | ||
|
||
[travis-badge]: https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started.svg | ||
[travis-link]: https://travis-ci.org/GoogleCloudPlatform/nodejs-getting-started | ||
[getting-started]: http://cloud.google.com/nodejs/getting-started | ||
[step-1]: https://cloud.google.com/nodejs/getting-started/hello-world | ||
[step-1-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/1-hello-world | ||
[step-2]: https://cloud.google.com/nodejs/getting-started/using-structured-data | ||
[step-2-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/2-structured-data | ||
[step-3]: https://cloud.google.com/nodejs/getting-started/using-cloud-storage | ||
[step-3-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/3-binary-data | ||
[step-4]: https://cloud.google.com/nodejs/getting-started/authenticate-users | ||
[step-4-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/4-auth | ||
[step-5]: https://cloud.google.com/nodejs/getting-started/logging-application-events | ||
[step-5-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/5-logging | ||
[step-6]: https://cloud.google.com/nodejs/getting-started/using-pub-sub | ||
[step-6-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/6-pubsub | ||
[step-7]: https://cloud.google.com/nodejs/getting-started/run-on-compute-engine | ||
[step-7-code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started/tree/master/7-gce |