grpc
/
grpc-node
mirror of https://github.com/grpc/grpc-node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gRPC for Node.js
1,004 Commits 51 Branches 291 Tags 26 MiB
TypeScript 85.8%
JavaScript 11.3%
C++ 1.4%
Shell 0.9%
Dockerfile 0.3%
Other 0.3%
Go to file
David Garcia Quintas a37737eb0c Version bump to 1.6 2017-08-16 21:01:30 -07:00
ext Node: fix segfault with incorrect status argument types 2017-07-31 13:15:19 -07:00
health_check Version bump to 1.6 2017-08-16 21:01:30 -07:00
interop auto-fix most of licenses 2017-06-08 11:22:41 +02:00
performance auto-fix most of licenses 2017-06-08 11:22:41 +02:00
src minor fix 2017-08-02 13:36:50 -07:00
stress auto-fix most of licenses 2017-06-08 11:22:41 +02:00
test Split tests more granularly 2017-08-01 10:41:52 -07:00
tools Version bump to 1.6 2017-08-16 21:01:30 -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 auto-fix most of licenses 2017-06-08 11:22:41 +02: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.