grpc-node/packages/grpc-native-core
Nicolas "Pixel" Noble 3b686ebe16 Builds. 2017-09-13 01:31:45 +02:00
..
deps Adding grpc as a submodule. 2017-09-12 23:47:48 +02:00
ext Moving files into their new location. 2017-09-12 01:33:18 +02:00
health_check Moving files into their new location. 2017-09-12 01:33:18 +02:00
interop Moving files into their new location. 2017-09-12 01:33:18 +02:00
performance Moving files into their new location. 2017-09-12 01:33:18 +02:00
src Moving files into their new location. 2017-09-12 01:33:18 +02:00
stress Moving files into their new location. 2017-09-12 01:33:18 +02:00
templates Builds. 2017-09-13 01:31:45 +02:00
test Moving files into their new location. 2017-09-12 01:33:18 +02:00
tools Adding generate_projects for our templates. 2017-09-12 23:48:32 +02:00
.jshintignore Moving files into their new location. 2017-09-12 01:33:18 +02:00
README.md Moving files into their new location. 2017-09-12 01:33:18 +02:00
binding.gyp Builds. 2017-09-13 01:31:45 +02:00
index.js Moving files into their new location. 2017-09-12 01:33:18 +02:00
jsdoc_conf.json Moving files into their new location. 2017-09-12 01:33:18 +02:00
package.json Moving package.json paths. 2017-09-13 00:52:31 +02: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.