History

Florian Nagel a36b429ae8 Fix deprecation warning Server#addProtoService and use Server#addService instead		2017-10-03 15:21:14 +02:00
..
dynamic_codegen	Fix deprecation warning Server#addProtoService and use Server#addService instead	2017-10-03 15:21:14 +02:00
static_codegen	Use https://grpc.io consistently as the canonical URL	2017-07-10 22:24:28 +00:00
.gitignore	move examples to correct locations	2015-08-27 14:00:20 -07:00
README.md	Use https://grpc.io consistently as the canonical URL	2017-07-10 22:24:28 +00: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 https://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