Skip to content

Latest commit

 

History

History
63 lines (61 loc) · 1.8 KB

README.md

File metadata and controls

63 lines (61 loc) · 1.8 KB
Raw

kratos-tpl

my go-kratos Project Template base on offical kratos layout

The BSR allows 10 unauthenticated code generation requests per hour, with a burst of up to 10 requests. If you send more than 10 unauthenticated requests per hour using remote plugins, you’ll receive a rate limit error. https://buf.build/docs/bsr/rate-limits

Features

  • use go-task rather than make
  • use buf for proto build
  • built in zap with lumbjack
  • use goreleaser to cross build

related tools

goreleaser (Optional)

go install github.com/goreleaser/goreleaser@latest

Task (Optional)

go install github.com/go-task/task/v3/cmd/task@latest

Buf

go install github.com/bufbuild/buf/cmd/buf@latest

for more info, please refer buf document

wire

go install github.com/google/wire/cmd/wire@latest

kratos

go install github.com/go-kratos/kratos/cmd/kratos/v2@latest && kratos upgrade

if you want to build all platform simply,you may need install goreleaser,and build with

goreleaser build --snapshot --clean

also you can create a release in your github,the compile is auto completed

usage

run the command:

kratos new <your App Name> -r https://github.com/tpl-x/kratos.git

or

kratos new <your App Name> -r [email protected]:tpl-x/kratos.git

to create your first Application

to generate api only using buf ,you can follow the steps below:

step 1:update buf dep

buf dep update

if you want to clean up unused dep. use buf dep prune

step 2 :generate api from protobuf

buf generate