grpc-web icon indicating copy to clipboard operation
grpc-web copied to clipboard

More explanation for the example for easier understanding?

Open emailtovamos opened this issue 5 years ago • 6 comments

Hi, I want to understand how I can connect Go backend with javascript frontend and the example here (https://github.com/improbable-eng/grpc-web/tree/master/example) seems to be doing it but I don't know where to start to understand file by file! So could anyone please mention how I can go about understanding it fully, assuming if someone starts from scratch? My main doubt is the exact point where the connection between Go backend and javascript frontend occurs. So a full mention path of following things would be great!

emailtovamos avatar Oct 14 '18 12:10 emailtovamos

I suggest you set a breakpoint on https://github.com/improbable-eng/grpc-web/blob/master/example/go/exampleserver/exampleserver.go#L42 and step through it.

easyCZ avatar Oct 14 '18 12:10 easyCZ

Hi @emailtovamos! If you do find that you've got a better understanding of how it works, would you be interested in contributing a simple summary for the examples README.md? Personally, checking out the repo and just looking at the code usually does it for me - but I'm a pretty experienced Go programmer so your milage might vary!

johanbrandhorst avatar Oct 14 '18 12:10 johanbrandhorst

Hi @johanbrandhorst , Sure, if I understand it completely then I can definitely contribute in creating a simple summary in the Readme. I am still unable to simply run it though. I get the error:

> ./get_go_deps.sh

'.' is not recognized as an internal or external command,

emailtovamos avatar Oct 21 '18 23:10 emailtovamos

Please clone the master branch instead, that script has been removed. Also you shouldn't need it unless you want to work on developing the gateway rather than just using it.

johanbrandhorst avatar Oct 22 '18 06:10 johanbrandhorst

Found this issue while browsing help-wanted tags here on Github.

It looks like the files linked above have since been moved or deleted, but the closest thing appears to be this folder, which was added/moved there about a month after this thread died: https://github.com/improbable-eng/grpc-web/tree/master/client/grpc-web-react-example

Is the readme.md file in that folder sufficient, or is there still work to do here?

wanderrful avatar Sep 19 '20 22:09 wanderrful

It's hard for us as maintainers to judge, as an outside party, do you think it explains enough? We'd love to improve the documentation if there's something missing.

johanbrandhorst avatar Sep 20 '20 06:09 johanbrandhorst