tool

artisan (tkeel-tool)

The artisan is a development tool for tKeel developers, which facilitates the rapid generation of framework code.

Getting Started

Required

• go
• protoc
• protoc-gen-go

Quick Start

# Install
go get -u github.com/tkeel-io/tkeel-interface/tool/cmd/artisan

# Create project template
artisan new github.com/tkeel-io/helloworld

cd helloworld

# Download necessary plug-ins
make init

# Generate proto template
artisan proto add api/helloworld/v1/helloworld.proto

# Generate proto source code
make api

# Generate service template
artisan proto service api/helloworld/v1/helloworld.proto -t pkg/service

# Generate server template (this output needs to be manually added to cmd/helloworld/main.go)
artisan proto server api/helloworld/v1/helloworld.proto

# Generate API's makedown
artisan markdown -f api/apidocs.swagger.json  -t third_party/markdown-templates/ -o ./docs/API/Greeter -m all

# Run the program
go run cmd/helloworld/main.go