-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Revived the example with a new structure and docs #5
base: master
Are you sure you want to change the base?
Conversation
|
|
||
docker-container: docker-image | ||
$(info $(M) Running docker application container...) | ||
docker run -p 8080:8080 example:latest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using $(info ...)
is neat, but I would remove any "advanced" features from this Makefile. Let's try to keep just the minimal to run the twirp example. Instead of that, we could add a comment.
cmd/client/main.go
Outdated
@@ -1,4 +1,4 @@ | |||
// Copyright 2018 Twitch Interactive, Inc. All Rights Reserved. | |||
// Copyright 2020 Twitch Interactive, Inc. All Rights Reserved. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2021 already 🎉
This is great @DennisSSDev, let's try to move it to the finish line! |
The vendor folder is explicitly required to generate the binary twirp tools (look at the makefile please). This is the simplest way I could make it, besides effectively forcing the end-user to manually install twirp on their machine. If we want to go towards that route, we can remove the vendor folder and make the makefile command look for a local version of the twirp tool binaries, but I think that would make playing around with this example faaar more difficult |
The requirement to allow The |
Description of changes:
The docs have been updated to follow the code structure more in sync as well as utilize a more modern code generation using
Makefile
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.