grpc/examples/node
Jan Tattermusch 7897ae9308 auto-fix most of licenses 2017-06-08 11:22:41 +02:00
..
dynamic_codegen auto-fix most of licenses 2017-06-08 11:22:41 +02:00
static_codegen auto-fix most of licenses 2017-06-08 11:22:41 +02:00
.gitignore move examples to correct locations 2015-08-27 14:00:20 -07:00
README.md Update README.md 2016-08-30 14:30:57 +08:00
package.json Update node protobuf dependency to 3.0.0 where applicable. Also update example dependency to grpc 1.0.0 2016-07-29 10:44:01 -07: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 $(curl -L http://grpc.io/release) 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