grpc
/
grpc-web
mirror of https://github.com/grpc/grpc-web.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Wenbo Zhu 2017-08-02 14:13:58 -07:00 committed by GitHub
parent 02924b8517
commit 89a706fd60
1 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -5,39 +5,33 @@ access a gRPC server.
The current release is a Pre-Alpha release, mainly for early adopters to provide The current release is a Pre-Alpha release, mainly for early adopters to provide
feedback on the JS API (both gRPC and Protobuf). The JS client library feedback on the JS API (both gRPC and Protobuf). The JS client library
has been used inside Google (Alphabet) with Closure compiler and its TypeScript generator (not yet open-sourced). has been used by Google (Alphabet) projects with Closure compiler and its TypeScript generator (not yet open-sourced).
The use of Closure compiler may or may not fit your JS development environment. The use of Closure compiler may or may not fit your JS development environment.
The gateway that connects the client to the server uses Nginx. However, The gateway that connects the client to the server uses Nginx. However,
Nginx still doesn't support HTTP/2 (to backends) as of Q2/2017, and therefore the gateway Nginx still doesn't support HTTP/2 (to backends) as of Q2/2017, and therefore the gateway
can't be used as a reverse proxy (for load balancing). We plan to add gRPC-Web support can't be used as a reverse proxy (for load balancing). We have also added the gRPC-Web support
to [Envoy](https://github.com/lyft/envoy) soon. We also expect gRPC-Web to be supported to [Envoy](https://github.com/lyft/envoy). In future, we expect gRPC-Web to be supported
in language-specific frameworks, such as Go, Java, Node, which will eliminate the need in language-specific Web frameworks, such as Go, Java, Node, which will eliminate the need
to deploy a gateway. to deploy a gateway.
We expect to ship an alpha version in Q3/2017. Stay tuned! [Sign-up form](https://docs.google.com/forms/d/15iRDHoP-VBenc4hWgKn7bk7IirJLgs0uh88nw1vi_Hc/viewform?edit_requested=true). We expect to ship an alpha version in Q3/2017. Stay tuned! [Sign-up form](https://docs.google.com/forms/d/15iRDHoP-VBenc4hWgKn7bk7IirJLgs0uh88nw1vi_Hc/viewform?edit_requested=true).
For questions, please file an issue or contact varuntalwar@google.com. For questions, please file an issue or contact varuntalwar@google.com.
## Build ## Generate and use the client library
gRPC-Web supports building on following the platforms: Please check the end-to-end echo example in net/grpc/gateway/examples/echo.
### Ubuntu 12.04 ## Build the gateway
1. Install docker.
2. run `./ubuntu\_12\_04.sh`
3. build result is available in net/grpc/gateway/docker/ubuntu\_12\_04 folder as
gConnector.zip and gConnector_static.zip.
### Ubuntu 14.04 ### Ubuntu 14.04, 12.04
1. Install docker. 1. Install docker.
2. run `./ubuntu\_14\_04.sh` 2. run `./ubuntu\_14\_04.sh`
3. build result is available in net/grpc/gateway/docker/ubuntu\_14\_04 folder as 3. build result is available in net/grpc/gateway/docker folder as gConnector.zip and gConnector_static.zip.
gConnector.zip and gConnector_static.zip.
### Mac OS X ### Mac OS X
1. Install brew. 1. Install brew.
2. `brew install autoconf automake libtool pcre` 2. `brew install autoconf automake libtool pcre`
3. run `./darwin\_x86\_64.sh` 3. run `./darwin\_x86\_64.sh`
4. build result is available in the root folder as gConnector.zip and 4. build result is available in the root folder as gConnector.zip and gConnector_static.zip.
gConnector_static.zip.