aboutsummaryrefslogtreecommitdiffhomepage
path: root/examples/node/README.md
blob: 09c56f7fa6f402cce6e1df6205ecdd1c17ebedee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
gRPC in 3 minutes (Node.js)
===========================

PREREQUISITES
-------------

- `node`: This requires Node 0.10.x or greater.
- [homebrew][] on Mac OS X.  This simplifies the installation of the gRPC C core.

INSTALL
-------
 - [Install gRPC Node][]

 - Install this package's dependencies

   ```sh
   $ cd examples/node
   $ npm install
   ```

TRY IT!
-------

 - Run the server

   ```sh
   $ # from this directory (grpc_common/node).
   $ node ./greeter_server.js &
   ```

 - Run the client

   ```sh
   $ # from this directory
   $ node ./greeter_client.js
   ```

NOTE
----
This directory has a copy of `helloworld.proto` because it currently depends on
some Protocol Buffer 2.0 syntax that is deprecated in Protocol Buffer 3.0.

TUTORIAL
--------
You can find a more detailed tutorial in [gRPC Basics: Node.js][]

[homebrew]:http://brew.sh
[Install gRPC Node]:../../src/node
[gRPC Basics: Node.js]:http://www.grpc.io/docs/tutorials/basic/node.html