grpc-node/examples
Michael Lumish 8f1a48c82c
Merge pull request #2489 from murgatroid99/example_deadline
Add deadline examples
2023-07-31 15:13:32 -07:00
..
deadline Add deadline examples 2023-06-28 14:49:52 -07:00
helloworld Import examples from core repository 2023-06-22 16:03:27 -07:00
metadata Use command line arguments more consistently 2023-06-28 14:52:54 -07:00
protos Add metadata example 2023-06-27 14:02:47 -07: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 Import examples from core repository 2023-06-22 16:03:27 -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