add gofrcli docs #1409
Open
add gofrcli docs #1409
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ccoVeille
reviewed
Jan 20, 2025
ccoVeille
approved these changes
Jan 20, 2025
Umang01-hash
approved these changes
Jan 22, 2025
coolwednesday
suggested changes
Jan 22, 2025
| @@ -165,7 +165,7 @@ export const navigation = [ | |||
| { | |||
| title: 'Testing', | |||
| href: '/docs/references/testing', | |||
| desc: "GoFR provides a centralized collection of mocks to facilitate writing effective unit tests. Explore testing strategies and tools for GoFR applications, ensuring your code is robust, reliable, and maintainable." | |||
| desc: "GoFR provides a centralized collection of mocks to facilitate writing effective unit tests. Explore testing strategies and tools for GoFR applications, ensuring the code is robust, reliable, and maintainable." | |||
| @@ -165,7 +165,7 @@ export const navigation = [ | |||
| { | |||
| title: 'Testing', | |||
| href: '/docs/references/testing', | |||
| desc: "GoFR provides a centralized collection of mocks to facilitate writing effective unit tests. Explore testing strategies and tools for GoFR applications, ensuring your code is robust, reliable, and maintainable." | |||
| desc: "GoFR provides a centralized collection of mocks to facilitate writing effective unit tests. Explore testing strategies and tools for GoFR applications, ensuring the code is robust, reliable, and maintainable." | |||
| } | |||
There was a problem hiding this comment.
Add the path to access the CLI documentation you have written.
Comment on lines
+3
to
+4
| Managing repetitive tasks, ensuring consistency across projects, and maintaining efficiency in a development workflow can be challenging, especially when working on large-scale applications. Tasks like initializing projects, handling database migrations can become tedious and repetitive. | ||
|
|
There was a problem hiding this comment.
Don't make it verbose...This part can be removed.
Comment on lines
+5
to
+6
| GoFr CLI addresses these challenges by providing a streamlined, all-in-one command-line tool specifically designed for GoFr applications. It simplifies tasks such as creating and managing database migrations, generating gRPC wrappers, and initializing new projects with standard GoFr conventions. | ||
|
|
There was a problem hiding this comment.
Make the features inline bold probably.
|
|
||
| GoFr CLI addresses these challenges by providing a streamlined, all-in-one command-line tool specifically designed for GoFr applications. It simplifies tasks such as creating and managing database migrations, generating gRPC wrappers, and initializing new projects with standard GoFr conventions. | ||
|
|
||
| For example, instead of manually setting up a new project structure, GoFr CLI can instantly scaffold a project with best practices in place. Similarly, managing database schema changes becomes effortless with its migration subcommands, ensuring that your database remains synchronized across environments. |
There was a problem hiding this comment.
Make it in points .....
Comment on lines
+111
to
+121
| 4. ***`version`*** | ||
|
|
||
| The version command allows you to check the current version of the GoFr CLI tool installed on your system. | ||
| Running this command ensures that you are using the latest version of the tool, helping you stay up to date with any new features, improvements, or bug fixes. | ||
| It's a quick way to verify which version of the GoFr CLI you have. | ||
|
|
||
| ### Command Usage | ||
|
|
||
| ```bash | ||
| gofr version | ||
| ``` |
There was a problem hiding this comment.
version should be right after, installation and not at the last.
Comment on lines
+64
to
+65
| 3. ***`wrap grpc`*** | ||
|
|
There was a problem hiding this comment.
For wrap grpc , write different section for gRPC server and different Section for gRPC Client ....
Refer the release notes of gofr-cli for the sever and client commands .... and also add the link to the examples folder for grpc-client and grpc-server.
Comment on lines
+70
to
+100
| ### Command Usage | ||
| ```bash | ||
| gofr wrap grpc server --proto=<path_to_the_proto_file> | ||
| ``` | ||
| ### Generated Files | ||
| - ```{serviceName}_gofr.go (auto-generated; do not modify)``` | ||
| - ```{serviceName}_server.go (example structure below)``` | ||
| - ```{serviceName}_client.go (auto-generated; do not modify)``` | ||
|
|
||
| ### Example Usage: | ||
| After generating the {serviceName}_client.go file, you can register and access the gRPC service as follows: | ||
|
|
||
| ```go | ||
| func main() { | ||
| app := gofr.New() | ||
|
|
||
| // Create a gRPC client for the Hello service | ||
| helloGRPCClient, err := {clientPackage}.NewHelloGoFrClient(app.Config.Get("GRPC_SERVER_HOST")) | ||
| if err != nil { | ||
| app.Logger().Errorf("Failed to create Hello gRPC client: %v", err) | ||
| return | ||
| } | ||
|
|
||
| greetHandler := NewGreetHandler(helloGRPCClient) | ||
|
|
||
| // Register HTTP endpoint for Hello service | ||
| app.GET("/hello", greetHandler.Hello) | ||
|
|
||
| // Run the application | ||
| app.Run() | ||
| } |
There was a problem hiding this comment.
You have written command for server, given code for the client.... Please fix this.....
Comment on lines
+106
to
+109
| - **Context-Aware Handling**: The generated server structure includes the necessary hooks to handle requests and responses seamlessly. | ||
| - **Minimal Configuration**: Simplifies gRPC handler setup, focusing on business logic rather than the infrastructure. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Add context allows you to access DB and add traces or have tracing in gRPC inter-service calls as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description:
Checklist:
goimportandgolangci-lint.Thank you for your contribution!