grpc/examples/node
Daren McCulley fbc5194df6
replace deprecated addProtoService (#25536)
2021-03-03 10:34:51 -08:00
..
dynamic_codegen replace deprecated addProtoService (#25536) 2021-03-03 10:34:51 -08:00
static_codegen Add target argument to Node examples 2020-11-23 12:40:32 -08:00
xds Node xDS example: show error on failure, close client when done 2020-11-25 12:48:06 -08:00
.gitignore move examples to correct locations 2015-08-27 14:00:20 -07:00
README.md Docs: fix links to grpc.io tutorial pages 2020-06-16 08:47:24 -04:00
package-lock.json Update Node examples to use @grpc/grpc-js 2020-11-05 11:24:27 -08:00
package.json Update Node examples to use @grpc/grpc-js 2020-11-05 11:24:27 -08:00

README.md

gRPC in 3 minutes (Node.js)

PREREQUISITES

  • node: This requires Node 0.12.x or greater.

INSTALL

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

$ cd examples/node
$ 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 ./dynamic_codegen/greeter_server.js &
    $ # OR
    $ node ./static_codegen/greeter_server.js &
    
  • Run the client

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

TUTORIAL

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