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
Michael Lumish 5e07d6096f
Merge pull request #159 from murgatroid99/v1.8.x_upmerge 
V1.8.x upmerge
 		2018-01-26 09:37:01 -05:00
..
deps Update submodule 2018-01-16 12:22:05 -05:00
ext Merge branch 'v1.8.x' into v1.8.x_upmerge 2018-01-22 13:00:51 -05:00
src Replace Argue.js usage with inline argument checking 2018-01-23 15:55:36 -05:00
templates Replace Argue.js usage with inline argument checking 2018-01-23 15:55:36 -05:00
test Revert "Copy API tests back to grpc-native-core" 2017-12-07 10:40:08 -08:00
tools Resolve comments 2017-11-29 16:34:34 -08: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 Generate projects 2018-01-16 12:28:25 -05:00
gulpfile.js simplify gulp commands in package directories 2017-12-14 16:41:24 -08:00
index.d.ts Tighten the definition of ServiceDefinition 2018-01-10 11:08:34 +01:00
index.js Fixed name of ServerCredentials.createSsl in native docs & types. 2017-11-08 09:41:55 +00:00
jsdoc_conf.json Move dependencies around, add gulp target for document generation 2017-09-20 12:39:16 -07:00
package.json Replace Argue.js usage with inline argument checking 2018-01-23 15:55:36 -05: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.