grpc-node/examples
Michael Lumish b1fd52d566 Add retry example 2025-01-29 12:40:24 -08:00
..
cancellation Cancellation example: corrected information 2023-10-02 10:12:03 -07:00
deadline Fix deprecated statement 2024-02-12 21:09:18 +01:00
error_handling Add error handling example 2023-09-26 09:46:56 -07:00
helloworld Fix deprecated statement 2024-02-12 21:09:18 +01:00
interceptors Add interceptors example 2024-03-21 14:47:42 -07:00
keepalive Address review comments 2024-03-13 15:16:42 -07:00
metadata Fix missing import 2024-02-12 21:09:43 +01:00
protos Add metadata example 2023-06-27 14:02:47 -07:00
reflection docs(grpc-reflection): added helloworld implementation for reflection example 2023-11-28 22:04:24 -05:00
retry Add retry example 2025-01-29 12:40:24 -08:00
routeguide Import examples from core repository 2023-06-22 16:03:27 -07:00
xds Import examples from core repository 2023-06-22 16:03:27 -07:00
README.md Import examples from core repository 2023-06-22 16:03:27 -07:00
package.json Add keepalive example 2024-03-13 15:04:16 -07:00

README.md

gRPC in 3 minutes (Node.js)

PREREQUISITES

  • node: This requires Node 8.13.0 or greater.

INSTALL

$ # Get the gRPC repository
$ export REPO_ROOT=grpc-node # REPO root can be any directory of your choice
$ git clone -b RELEASE_TAG_HERE https://github.com/grpc/grpc-node $REPO_ROOT
$ cd $REPO_ROOT

$ cd examples
$ npm install

TRY IT!

There are two ways to generate the code needed to work with protocol buffers in Node.js - one approach uses Protobuf.js to dynamically generate the code at runtime, the other uses code statically generated using the protocol buffer compiler protoc. The examples behave identically, and either server can be used with either client.

  • Run the server

    $ # from this directory
    $ node ./helloworld/dynamic_codegen/greeter_server.js &
    $ # OR
    $ node ./helloworld/static_codegen/greeter_server.js &
    
  • Run the client

    $ # from this directory
    $ node ./helloworld/dynamic_codegen/greeter_client.js
    $ # OR
    $ node ./helloworld/static_codegen/greeter_client.js
    

TUTORIAL

You can find a more detailed tutorial in gRPC Basics: Node.js