grpc-experiments/node
Jayant Kolhe 0718d2b38e Merge pull request #225 from tbetbetbe/grpc-nodejs-update-helloworld-install
Updates the nodejs helloworld INSTALL
2015-06-03 13:43:41 -07:00
..
route_guide added link to new public proto3 doc 2015-04-27 11:49:57 +01:00
.gitignore Added node hello world example 2015-02-19 13:33:04 -08:00
README.md Updates the INSTALL nodejs helloworld 2015-06-03 11:49:47 -07:00
greeter_client.js revert js changes. 2015-02-20 11:35:20 -08:00
greeter_server.js revert js changes. 2015-02-20 11:35:20 -08:00
helloworld.proto change proto README cpp node ruby 2015-02-20 10:50:46 -08:00
package.json update node grpc package dependencies 2015-05-29 15:16:18 -07:00

README.md

gRPC in 3 minutes (Node.js)

PREREQUISITES

  • node: This requires Node 10.x or greater.
  • homebrew on Mac OS X, linuxbrew on Linux. These simplify the installation of the gRPC C core.

INSTALL

  • On Mac OS X, install homebrew. On Linux, install linuxbrew. Run the following command to install gRPC Node.js.
$ curl -fsSL https://goo.gl/getgrpc | bash -s nodejs

This will download and run the gRPC install script, then install the latest version of gRPC Nodejs npm package.

  • Clone this repository

    $ git clone https://github.com/grpc/grpc-common.git
    
  • Install this package's dependencies

    $ cd grpc-common/node
    $ npm install
    

TRY IT!

  • Run the server

    $ # from this directory (grpc_common/node).
    $ node ./greeter_server.js &
    
  • Run the client

    $ # from this directory
    $ node ./greeter_client.js
    

NOTE

This directory has a copy of helloworld.proto because it currently depends on some Protocol Buffer 2.0 syntax that is deprecated in Protocol Buffer 3.0.

TUTORIAL

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