github.com/ronaksoft/rony@v0.16.26-0.20230807065236-1743dbfe6959/docs/content/getting-started.md (about)

     1  ---
     2  title: "Getting Started"
     3  date: 2021-07-26T14:33:20+04:30
     4  draft: false
     5  weight: 50
     6  menu: "main"
     7  tags: ["wiki", "install", "guide"]
     8  categories: ["wiki"]
     9  weight: 20
    10  contentCopyright: MIT
    11  mathjax: true
    12  autoCollapseToc: true
    13  
    14  ---
    15  
    16  # Prepare
    17  To install Rony we need to have protoc compiler installed in our system. With a quick search we can
    18  find good resources. Some useful references provided here:
    19  * https://grpc.io/docs/protoc-installation/ 
    20  * http://google.github.io/proto-lens/installing-protoc.html
    21  
    22  
    23  We also need to install protoc golang plugin from [here](https://github.com/golang/protobuf)
    24  
    25  # Install Rony
    26  To install Rony just run: `GO111MODULE=on go get -u github.com/ronaksoft/rony/...` or in Go 1.16 and above use: `go install github.com/ronaksoft/rony/...`
    27  
    28  Rony has its own protoc plugin which is required to generate codes based on your `proto` files. Make sure `/cmd/protoc-gen-gorony` is installed
    29  on your path. **Usually `go install` takes care of this.**
    30  
    31  
    32  # First Project
    33  To crate your first project, we need to use `rony` executable which is installed in previous section. We could 
    34  find out about the flags by calling `rony -h`. To create our new project skeleton run :
    35  
    36  ```shell
    37  mkdir sample-project
    38  cd ./sample-project
    39  rony create-project --project.name github.com/ronaksoft/sample --project.name sample-project
    40  ```
    41  
    42  There are some examples in `./example` directory.