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 13746e23c2 Update master submodule 2018-05-07 14:40:32 -07:00
..
deps Update master submodule 2018-05-07 14:40:32 -07:00
ext typo 2018-04-23 17:28:47 +08:00
src Merge pull request #207 from theogravity/master 2018-03-13 17:13:52 -07:00
templates Merge branch 'v1.11.x' of https://github.com/grpc/grpc-node into node-10 2018-05-02 04:31:39 +02:00
test Start server after adding server ports 2018-04-03 10:57:04 -07:00
tools Better this way... 2018-05-02 05:36:19 +02: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 master submodule 2018-05-07 14:40:32 -07:00
build.yaml Remove version change in build.yaml 2018-05-03 15:23:58 -07:00
gulpfile.js simplify gulp commands in package directories 2017-12-14 16:41:24 -08:00
index.d.ts fix: use capital `F` for `Function` when used as a type 2018-05-02 15:24:34 -07:00
index.js Update error msg for Protobuf.js detection from 'protobufjs_version' to 'protobufjsVersion' 2018-04-03 19:58:42 -04:00
jsdoc_conf.json Move dependencies around, add gulp target for document generation 2017-09-20 12:39:16 -07:00
package.json Update master submodule 2018-05-07 14:40:32 -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.