gRPC for Node.js
Go to file
murgatroid99 26c4bffa79 Upgrade Protobuf.js 6 code to work with 6.8 2017-06-14 14:47:05 -07:00
ext Merge remote-tracking branch 'upstream/v1.3.x' into master_1.3.x_upmerge 2017-05-25 15:13:27 -07:00
health_check 1.4.x branch cut, version bump PR 2017-05-30 14:11:38 -07:00
interop Upgrade Node dependency on Protobuf.js to version 6 2017-03-17 13:13:05 -07:00
performance Node benchmarks: allow arbitrary message size, add CPU usage stats 2017-04-18 11:05:00 -07:00
src Upgrade Protobuf.js 6 code to work with 6.8 2017-06-14 14:47:05 -07:00
stress Upgrade Node dependency on Protobuf.js to version 6 2017-03-17 13:13:05 -07:00
test Node: add test for reconnecting client after server restart 2017-06-09 13:04:28 -07:00
tools 1.4.x branch cut, version bump PR 2017-05-30 14:11:38 -07:00
.jshintignore Use math test to test generated code 2016-04-20 10:52:31 -07:00
README.md Refactor some code and document most of the API 2017-05-23 10:29:29 -07:00
index.js Merge branch 'master' into node_api_docs 2017-05-23 10:34:54 -07:00
jsdoc_conf.json Move gRPC constants to js file to include them in generated documentation 2017-05-10 16:24:05 -07:00

README.md

npm

Node.js gRPC Library

PREREQUISITES

  • node: This requires node to be installed, version 4.0 or above. If you instead have the nodejs executable on Debian, you should install the nodejs-legacy package.

  • Note: If you installed node via a package manager and the version is still less than 4.0, try directly installing it from nodejs.org.

INSTALLATION

Install the gRPC NPM package

npm install grpc

BUILD FROM SOURCE

  1. Clone the grpc Git Repository.
  2. Run npm install --build-from-source from the repository root.
  • Note: On Windows, this might fail due to nodejs issue #4932 in which case, you will see something like the following in npm install's output (towards the very beginning):

     ..
     Building the projects in this solution one at a time. To enable parallel build, please add the "/m" switch.
     WINDOWS_BUILD_WARNING
      "..\IMPORTANT: Due to https:\github.com\nodejs\node\issues\4932, to build this library on Windows, you must first remove C:\Users\jenkins\.node-gyp\4.4.0\include\node\openssl"
      ...
      ..
    

    To fix this, you will have to delete the folder C:\Users\<username>\.node-gyp\<node_version>\include\node\openssl and retry npm install

TESTING

To run the test suite, simply run npm test in the install location.