grpc
/
grpc-node
mirror of https://github.com/grpc/grpc-node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
grpc-node/packages/grpc-native-core
History
murgatroid99 bea99a7b9b Update v1.7.x branch to 1.7.3 2017-12-06 11:52:39 -08:00
..
deps Update v1.7.x branch to 1.7.3 2017-12-06 11:52:39 -08:00
ext Remove now-incorrect assertion in completion queue wrapper 2017-11-16 09:51:32 -08:00
src Fix type links 2017-09-29 14:17:11 +02:00
templates Add libc variable to binary paths in package.json template 2017-11-16 10:08:08 -08:00
test Move more tests from native core to API test directory 2017-10-10 18:28:41 -07:00
tools Update to 1.7.1, add Node 9 support, fix generated file permissions 2017-11-02 10:13:22 -07:00
.jshintignore Moving files into their new location. 2017-09-12 01:33:18 +02:00
.npmignore Remove some unnecessary files from the native npm package 2017-09-19 11:18:00 -07:00
README.md Update package descriptions in README, add API docs link 2017-09-14 13:03:21 -07:00
binding.gyp Update submodule to v1.7.0 and regenerate packages 2017-11-01 09:55:23 -07:00
gulpfile.js Merge branch 'master' into dependency_cleanup 2017-09-28 16:41:34 -07:00
index.d.ts Added missing streaming implementations 2017-10-06 21:48:16 +02:00
index.js Fix type links 2017-09-29 14:17:11 +02:00
jsdoc_conf.json Move dependencies around, add gulp target for document generation 2017-09-20 12:39:16 -07:00
package.json Update v1.7.x branch to 1.7.3 2017-12-06 11:52:39 -08: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

API DOCUMENTATION

See the API Documentation.

TESTING

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