Skip to content

Commit c64493c

Browse files
committed
Re-organized readme files.
1 parent 37c7cd6 commit c64493c

File tree

18 files changed

+759
-368
lines changed

18 files changed

+759
-368
lines changed

README.md

Lines changed: 270 additions & 242 deletions
Large diffs are not rendered by default.

appengine/README.md

Lines changed: 143 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,146 @@ create a project/app id. (App id and project id are identical.)
4848

4949
gcloud preview app deploy
5050

51-
1. Awesome! Your application is now live at `your-app-id.appspot.com`.
51+
1. Awesome! Your application is now live at `your-project-id.appspot.com`.
52+
53+
54+
## Samples
55+
__Google (Cloud) Products__
56+
57+
- Google Analytics - [Source code][aeanalytics_1]
58+
- Google Cloud Logging - [Source code][aelogging_1]
59+
- Google Cloud Pub/Sub - [Source code][aepubsub_1]
60+
- Google Cloud Storage - [Source code][aestorage_1]
61+
62+
__Frameworks__
63+
64+
- Express.js - [Source code][express_1] | [App Engine Tutorial][express_2] | [Live demo][express_3] | [Documentation][express_4]
65+
- Express.js + Memcached Sessions - [Source code][express_5] | [Documentation][express_6]
66+
- Geddy.js - [Source code][geddy_1] | [App Engine Tutorial][geddy_2] | [Live demo][geddy_3] | [Documentation][geddy_4]
67+
- Hapi.js - [Source code][hapi_1] | [App Engine Tutorial][hapi_2] | [Live demo][hapi_3] | [Documentation][hapi_4]
68+
- Loopback.js - [Source code][loopback_1] | [App Engine Tutorial][loopback_2] | [Live demo][loopback_3] | [Documentation][loopback_4]
69+
- Koa.js - [Source code][koa_1] | [App Engine Tutorial][koa_2] | [Live demo][koa_3] | [Documentation][koa_4]
70+
- Kraken.js - [Source code][kraken_1] | [App Engine Tutorial][kraken_2] | [Live demo][kraken_3] | [Documentation][kraken_4]
71+
- Parse-server - [Source code][parse_1]
72+
- Restify.js - [Source code][restify_1] | [App Engine Tutorial][restify_2] | [Live demo][restify_3] | [Documentation][restify_4]
73+
- Sails.js - [Source code][sails_1] | [App Engine Tutorial][sails_2] | [Live demo][sails_3] | [Documentation][sails_4]
74+
75+
__Databases__
76+
77+
- Google Cloud Datastore - [Source code][aedatastore_1]
78+
- Google Cloud SQL - [Source code][aecloudsql_1]
79+
- Memcached - [Source code][memcached_1]
80+
- MongoDB - [Source code][mongodb_1] | [App Engine Tutorial][mongodb_2] | [Documentation][mongodb_3]
81+
- Redis - [Source code][redis_1] | [App Engine Tutorial][redis_2] | [Documentation][redis_3]
82+
83+
__Tools__
84+
85+
- gcloud-node - [Source code][gcloud_1] | [Documentation][gcloud_2]
86+
- Bower - [Source code][bower_1] | [App Engine Tutorial][bower_2] | [Documentation][bower_3]
87+
- Grunt - [Source code][grunt_1] | [App Engine Tutorial][grunt_2] | [Live demo][grunt_3] | [Documentation][grunt_4]
88+
- Mailgun - [Source code][mailgun_1] | [App Engine Tutorial][mailgun_2] | [Documentation][mailgun_3]
89+
- Sendgrid - [Source code][sendgrid_1] | [App Engine Tutorial][sendgrid_2] | [Documentation][sendgrid_3]
90+
- Twilio - [Source code][twilio_1]
91+
- Webpack - [Source code][webpack_1] | [App Engine Tutorial][webpack_2] | [Documentation][webpack_3]
92+
- WebSockets - [Source code][websockets_1]
93+
94+
__Other Examples__
95+
96+
- Express.js Hello World - [Source code][expresshw_1]
97+
- Extending the runtime - [Source code][aeextending_1]
98+
- Reading/writing from/to disk - [Source code][aedisk_1]
99+
- Serving static files - [Source code][aestaticfiles_1]
100+
101+
[aeanalytics_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/analytics
102+
[aelogging_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/logging
103+
[aepubsub_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/pubsub
104+
[aestorage_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/storage
105+
106+
[express_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/express
107+
[express_2]: https://cloud.google.com/nodejs/resources/frameworks/express
108+
[express_3]: http://express-dot-nodejs-docs-samples.appspot.com
109+
[express_4]: http://expressjs.com/
110+
[express_5]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/express-memcached-session
111+
[express_6]: https://github.com/balor/connect-memcached
112+
113+
[geddy_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/geddy
114+
[geddy_2]: https://cloud.google.com/nodejs/resources/frameworks/geddy
115+
[geddy_3]: http://geddy-dot-nodejs-docs-samples.appspot.com
116+
[geddy_4]: http://geddyjs.org/
117+
118+
[hapi_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/hapi
119+
[hapi_2]: https://cloud.google.com/nodejs/resources/frameworks/hapi
120+
[hapi_3]: http://hapi-dot-nodejs-docs-samples.appspot.com
121+
[hapi_4]: http://hapijs.com/
122+
123+
[loopback_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/loopback
124+
[loopback_2]: https://cloud.google.com/nodejs/resources/frameworks/loopback
125+
[loopback_3]: http://loopback-dot-nodejs-docs-samples.appspot.com
126+
[loopback_4]: http://loopback.io/
127+
128+
[koa_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/koa
129+
[koa_2]: https://cloud.google.com/nodejs/resources/frameworks/koa
130+
[koa_3]: http://koa-dot-nodejs-docs-samples.appspot.com
131+
[koa_4]: http://koajs.com/
132+
133+
[kraken_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/kraken
134+
[kraken_2]: https://cloud.google.com/nodejs/resources/frameworks/kraken
135+
[kraken_3]: http://kraken-dot-nodejs-docs-samples.appspot.com
136+
[kraken_4]: http://krakenjs.com/
137+
138+
[parse_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/parse-server
139+
140+
[restify_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/restify
141+
[restify_2]: https://cloud.google.com/nodejs/resources/frameworks/restify
142+
[restify_3]: http://restify-dot-nodejs-docs-samples.appspot.com
143+
[restify_4]: http://restify.com/
144+
145+
[sails_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/sails
146+
[sails_2]: https://cloud.google.com/nodejs/resources/frameworks/sails
147+
[sails_3]: http://sails-dot-nodejs-docs-samples.appspot.com
148+
[sails_4]: http://sailsjs.org/
149+
150+
[aedatastore_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/datastore
151+
[aecloudsql_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/cloudsql
152+
[memcached_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/memcached
153+
154+
[mongodb_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/mongodb
155+
[mongodb_2]: https://cloud.google.com/nodejs/resources/databases/mongodb
156+
[mongodb_3]: https://docs.mongodb.org/
157+
158+
[redis_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/redis
159+
[redis_2]: https://cloud.google.com/nodejs/resources/databases/redis
160+
[redis_3]: https://redis.io/
161+
162+
[gcloud_1]: https://github.com/GoogleCloudPlatform/gcloud-node
163+
[gcloud_2]: https://googlecloudplatform.github.io/gcloud-node/#/
164+
165+
[bower_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/bower
166+
[bower_2]: https://cloud.google.com/nodejs/resources/tools/bower
167+
[bower_3]: http://bower.io/
168+
169+
[grunt_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/grunt
170+
[grunt_2]: https://cloud.google.com/nodejs/resources/tools/grunt
171+
[grunt_3]: http://grunt-dot-nodejs-docs-samples.appspot.com
172+
[grunt_4]: http://gruntjs.com/
173+
174+
[mailgun_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/mailgun
175+
[mailgun_2]: https://cloud.google.com/nodejs/resources/tools/mailgun
176+
[mailgun_3]: http://www.mailgun.com/
177+
178+
[sendgrid_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/sendgrid
179+
[sendgrid_2]: https://cloud.google.com/nodejs/resources/tools/sendgrid
180+
[sendgrid_3]: http://sendgrid.com/
181+
182+
[twilio_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/twilio
183+
184+
[webpack_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/webpack
185+
[webpack_2]: https://cloud.google.com/nodejs/resources/tools/webpack
186+
[webpack_3]: https://webpack.github.io/
187+
188+
[websockets_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/websockets
189+
190+
[expresshw_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/hello-world
191+
[aedisk_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/disk
192+
[aeextending_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/extending-runtime
193+
[aestaticfiles_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/static-files

bigquery/README.md

Lines changed: 62 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,84 @@
1-
## BigQuery Samples
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
22

3-
These samples require two environment variables to be set:
3+
# Google BigQuery Node.js Samples
44

5-
- `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account file. You can
6-
download one from your Google project's "permissions" page.
7-
- `GCLOUD_PROJECT` - Id of your Google project.
5+
[BigQuery][bigquery_docs] is Google's fully managed, petabyte scale, low cost
6+
analytics data warehouse.
87

9-
## Run the samples
8+
[bigquery_docs]: https://cloud.google.com/bigquery/docs/
109

11-
Install dependencies:
10+
## Table of Contents
1211

13-
npm install
12+
* [Setup](#setup)
13+
* [Samples](#samples)
14+
* [Create A Simple Application With the API](#create-a-simple-application-with-the-api)
15+
* [Calculate size of dataset](#calculate-size-of-dataset)
16+
* [Loading Data with a POST Request](#loading-data-with-a-post-request)
17+
* [Loading Data from Cloud Storage](#loading-data-from-cloud-storage)
1418

15-
### getting_started.js
19+
## Setup
1620

17-
npm run getting_started
21+
1. Read [Prerequisites][prereq] and [How to run a sample][run] first.
22+
1. Install dependencies:
1823

19-
### dataset_size.js
24+
npm install
2025

21-
Usage: `npm run dataset_size -- <projectId> <datasetId>`
26+
[prereq]: ../README.md#prerequisities
27+
[run]: ../README.md#how-to-run-a-sample
28+
29+
## Samples
30+
31+
### Create A Simple Application With the API
32+
33+
View the [documentation][basics_1] or the [source code][basics_2].
34+
35+
__Run the sample:__
36+
37+
node getting_started
38+
39+
[basics_1]: getting_started.js
40+
[basics_2]: https://cloud.google.com/bigquery/create-simple-app-api
41+
42+
### Calculate size of dataset
43+
44+
View the [source code][size_1].
45+
46+
__Run the sample:__
47+
48+
Usage: `node dataset_size <projectId> <datasetId>`
2249

2350
Example:
2451

25-
npm run dataset_size -- bigquery-public-data hacker_news
52+
node dataset_size bigquery-public-data hacker_news
53+
54+
[size_1]: dataset_size.js
55+
56+
### Loading Data with a POST Request
57+
58+
View the [documentation][file_1] or the [source code][file_2].
2659

27-
### load_data_from_csv.js
60+
__Run the sample:__
2861

29-
Usage: `npm run load_data_from_csv -- <path-to-file> <dataset-id> <table-name>`
62+
Usage: `node load_data_from_csv <path-to-file> <dataset-id> <table-name>`
3063

3164
Example:
3265

33-
npm run load_data_from_csv -- data.csv my-dataset my-table
66+
node load_data_from_csv resources/data.csv my-dataset my-table
3467

35-
### load_data_from_gcs.js
68+
[file_1]: load_data_from_csv.js
69+
[file_2]: https://cloud.google.com/bigquery/loading-data-post-request
3670

37-
Usage: `npm run load_data_from_gcs -- <bucket-name> <filename> <dataset-id> <table-name>`
71+
### Loading Data from Cloud Storage
72+
73+
View the [documentation][gcs_1] or the [source code][gcs_2].
74+
75+
__Run the sample:__
76+
77+
Usage: `node load_data_from_gcs <bucket-name> <filename> <dataset-id> <table-name>`
3878

3979
Example:
4080

41-
npm run load_data_from_gcs -- my-bucket data.csv my-dataset my-table
81+
node load_data_from_gcs my-bucket data.csv my-dataset my-table
82+
83+
[gcs_1]: load_data_from_gcs.js
84+
[gcs_2]: https://cloud.google.com/bigquery/docs/loading-data-cloud-storage

computeengine/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,11 @@ set.
3333

3434
npm run vms_api
3535

36+
- Sendgrid sample - [Source code][compute_sendgrid_1] | [Documentation][compute_sendgrid_2]
37+
- VMs sample - [Source code][compute_vms_1] | [Documentation][compute_vms_2]
38+
39+
[compute_sendgrid_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/computeengine/sendgrid.js
40+
[compute_sendgrid_2]: https://cloud.google.com/compute/docs/tutorials/sending-mail/using-sendgrid
41+
42+
[compute_vms_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/computeengine/vms.js
43+
[compute_vms_2]: https://cloud.google.com/compute/docs/tutorials/nodejs-guide

datastore/README.md

Lines changed: 53 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,65 @@
1-
## Datastore Samples
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
22

3-
These samples require two environment variables to be set:
3+
# Google Cloud Datastore Node.js Samples
44

5-
- `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account file. You can
6-
download one from your Google project's "permissions" page.
7-
- `GCLOUD_PROJECT` - Id of your Google project.
5+
[Cloud Datastore][datastore_docs] is a NoSQL document database built for
6+
automatic scaling, high performance, and ease of application development.
87

9-
## Run a sample
8+
[datastore_docs]: https://cloud.google.com/datastore/docs/
109

11-
Install dependencies:
10+
## Table of Contents
1211

13-
```
14-
$ npm install
15-
```
12+
* [Setup](#setup)
13+
* [Samples](#samples)
14+
* [Getting started with Google Cloud Datastore API](#getting-started-with-google-cloud-datastore-api)
15+
* [Concepts](#concepts)
16+
* [Errors and Error Handling](#errors-and-error-handling)
1617

17-
To print available commands:
18+
## Setup
1819

19-
```
20-
$ npm run
21-
```
20+
1. Read [Prerequisites][prereq] and [How to run a sample][run] first.
21+
1. Install dependencies:
2222

23-
Execute a sample:
23+
npm install
2424

25-
```
26-
$ npm run <sample> -- [arg_1] [arg_2] [arg_n]
27-
```
25+
[prereq]: ../README.md#prerequisities
26+
[run]: ../README.md#how-to-run-a-sample
27+
28+
## Samples
29+
30+
### Getting started with Google Cloud Datastore API
31+
32+
View the [documentation][tasks_1] or the [source code][tasks_2].
33+
34+
__Run the sample:__
35+
36+
Usage: `node tasks <command> [args]...`
37+
38+
Print usage:
39+
40+
node tasks
2841

2942
Example:
3043

31-
```
32-
$ npm run tasks -- list
33-
```
44+
node tasks list
45+
46+
[tasks_1]: tasks.js
47+
[tasks_2]: https://cloud.google.com/datastore/docs/datastore-api-tutorial
48+
49+
### Concepts
50+
51+
View the [documentation][concepts_1] or the [source code][concepts_2].
52+
53+
[concepts_1]: concepts.js
54+
[concepts_2]: https://cloud.google.com/datastore/docs/concepts/entities
55+
56+
### Errors and Error Handling
57+
58+
View the [documentation][error_1] or the [source code][error_2].
59+
60+
__Run the sample:__
61+
62+
node error
63+
64+
[error_1]: error.js
65+
[error_2]: https://cloud.google.com/datastore/docs/concepts/errors

functions/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
2+
3+
# Google Cloud Functions Node.js Samples
4+
5+
[Cloud Functions][functions_docs] is a lightweight, event-based, asynchronous
6+
compute solution that allows you to create small, single-purpose functions that
7+
respond to Cloud events without the need to manage a server or a runtime
8+
environment.
9+
10+
[functions_signup]: https://docs.google.com/a/google.com/forms/d/1WQNWPK3xdLnw4oXPT_AIVR9-gd6DLo5ZIucyxzSQ5fQ/viewform
11+
[functions_docs]: https://cloud.google.com/functions/docs/
12+
13+
## Setup
14+
15+
1. Read [Prerequisites][prereq] and [How to run a sample][run] first.
16+
17+
[prereq]: ../README.md#prerequisities
18+
[run]: ../README.md#how-to-run-a-sample
19+
20+
## Samples
21+
22+
* [Hello World](helloworld/)
23+
* [Logging](log/)
24+
* [Callbacks](messages/)
25+
* [Modules](module/)
26+
* [Dependencies](uid/)

0 commit comments

Comments
 (0)