readyGo v0.0.1 Released

https://github.com/JitenPalaparthi/readyGo/releases/tag/v0.0.1

Overview

A Simple configuration gives you a working project.

• readyGo is a command line interface( probably the name of readyGo CLI would be readyGo itself) application, it is designed to scaffold creation of different types of go based projects.readyGo is designed for developers in mind. Ideally readyGo should provide ready to use application code. The code is generated based on configurations provided by the end user i.e "The great developer :)".
• By version 1 release, it will support http, grpc, CloudEvents template engines with various databases (sql/no sql), pub-sub and CloudEvents plugins and probably even more.

readGo cooks for you.As your business logic varies , you have to add the required spices according your taste but one thing .. readyGo is not a template engine, it gives you a working project.

How to run

• Download release versions based on your OS.
• untar or un zip the appropriate zipped file.
• rename or mv the file from readyGo_v0.0.1_xxxxx_xxx.xx to readyGo
• Give proper permissions to execute the file. example in linux

chmod 744 readyGo

• go to the directory where readyGo binary is ,

./readyGo version

./readyGo help

• To create a project readyGo should have a config file that is either in json or in yaml. The below is the sample file

{
  "version":"0.1",
  "project": "PersonInfo",
  "type": "http",
  "port": "50055",
  "db": "mongo",
  "models": [
    {
      "name": "person",
      "fields": [
         {
          "name": "name",
          "type": "string",
          "isKey": true
        },
        {
          "name": "email",
          "type": "string",
          "validateExp": "[a-zA-Z0-9]",
          "isKey": true
        },
        {
          "name": "mobile",
          "type": "string"
        },
        {
          "name": "status",
          "type": "string"
        },
        {
          "name": "last_Modified",
          "type": "string"
        }
      ]
    },{
    "name": "address",
    "fields": [
       {
        "name": "addressline",
        "type": "string"
        
      },
      {
        "name": "city",
        "type": "string"
         },
      {
        "name": "state",
        "type": "string"
      },
      {
        "name": "country",
        "type": "string"
      },
      {
        "name": "pincode",
        "type": "string"
      },
      {
        "name": "status",
        "type": "string"
      },
      {
        "name": "last_Modified",
        "type": "string"
      }
    ]
  }
  ]
}

• Copy the contents of the file and save it as config.json

.readyGo apply -f config.json 

• The output would be a project with the given name in the config.
• Make sure Go is installed in your machine as it gives GoLang project
• cd to the project
• go mod init project_name
• go run main.go
• Congratulations.. Your restful service is up and running

Any bugs ?

• Please report them in issues github.

Disclaimer: Content is created by Jiten and typos are by keyboard :) (This quote is taken from Ashwin Palaparthi).