Google Cloud Platform Node.js Samples

Node.js samples for Google Cloud Platform products.

See cloud.google.com/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 page.

Setup

1. Install Node.js version 18 or greater
2. Install the Google Cloud CLI (gcloud)

3. Clone this repository:

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

4. Obtain authentication credentials.

   Create local credentials by running the following command and following the oauth2 flow (read more about the command here):

   gcloud auth application-default login
   

   Read more about Google Cloud Platform Authentication.

How to run a sample

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

   cd run/helloworld
   

2. 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
     

3. Run the sample:

   npm start [args]...
   

Other sample applications

Bookshelf tutorial app

The Bookshelf app 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 or the source code.

Contributing

Contributions welcome! See the Contributing Guide.