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 da03fc5db8 Merge branch 'master' into package_split 2017-10-12 14:50:43 -07:00
..
deps Update grpc submodule 2017-10-02 13:49:05 -07:00
ext Update grpc submodule 2017-10-02 13:49:05 -07:00
src Fix type links 2017-09-29 14:17:11 +02:00
templates Put packages in @grpc scope, add linking scripts 2017-10-12 13:40:18 -07:00
test Get tests from the C-based library working and add corresponding gulp tasks 2017-09-13 13:54:13 -07:00
tools/buildgen Merge pull request #18 from nicolasnoble/making-node-work-again 2017-09-12 17:19:01 -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 grpc submodule 2017-10-02 13:49:05 -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 Merge branch 'master' into package_split 2017-10-12 14:50:43 -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

API DOCUMENTATION

See the API Documentation.

TESTING

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