https://github.com/googlecloudplatform/nodejs-docs-samples

Node.js samples for Google Cloud Platform products.
https://github.com/googlecloudplatform/nodejs-docs-samples

api cloud examples google-cloud javascript nodejs sample samples

Last synced: 5 days ago
JSON representation

Node.js samples for Google Cloud Platform products.

• Host: GitHub
• URL: https://github.com/googlecloudplatform/nodejs-docs-samples
• Owner: GoogleCloudPlatform
• License: apache-2.0
• Created: 2015-05-04T23:26:38.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-12-17T00:58:31.000Z (about 2 months ago)
• Last Synced: 2024-12-18T08:41:10.460Z (about 2 months ago)
• Topics: api, cloud, examples, google-cloud, javascript, nodejs, sample, samples
• Language: JavaScript
• Homepage: https://cloud.google.com/nodejs
• Size: 81.2 MB
• Stars: 2,828
• Watchers: 235
• Forks: 1,957
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


# Google Cloud Platform Node.js Samples

Node.js samples for [Google Cloud Platform products][cloud].

See [cloud.google.com/nodejs][cloud_nodejs] to get up and running with Node.js

on Google Cloud Platform.

To browse documentation pages that use the samples found in this repository,

visit the [Google Cloud Samples][cloud_samples] page.

[cloud]: https://cloud.google.com/

[cloud_nodejs]: https://cloud.google.com/nodejs/

[cloud_samples]: https://cloud.google.com/docs/samples?language=nodejs%2Ctypescript

## Setup

1. Install [Node.js version 14 or greater][node]

1. Install the [Google Cloud CLI (gcloud)][gcloud]

1. Clone this repository:

        git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

1. Obtain authentication credentials.

    Create local credentials by running the following command and following the

    oauth2 flow (read more about the command [here][auth_command]):

        gcloud auth application-default login

    Read more about [Google Cloud Platform Authentication][gcp_auth].

[node]: https://nodejs.org/

[gcloud]: https://cloud.google.com/sdk/docs/install

[auth_command]: https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login

[gcp_auth]: https://cloud.google.com/docs/authentication#projects_and_resources

## How to run a sample

1. Change directory to one of the sample folders, e.g. `run/helloworld`:

        cd run/helloworld

1. Install the sample's dependencies (see the sample's README for details):

        npm install

      * For samples with an available TypeScript variant, compile the 

      TypeScript code:

   

                npm run build

1. Run the sample:

        npm start [args]...

## Other sample applications

### Bookshelf tutorial app

The [Bookshelf app][bookshelf_docs] is a sample web app written in Node.js that

shows you how to use a variety of Google Cloud Platform features.

View the [tutorial][bookshelf_docs] or the [source code][bookshelf_code].

[bookshelf_docs]: https://cloud.google.com/nodejs/getting-started/tutorial-app

[bookshelf_code]: https://github.com/GoogleCloudPlatform/nodejs-getting-started

## Contributing

Contributions welcome! See the [Contributing Guide][contrib].

[contrib]: CONTRIBUTING.md