truss/README.md

Truss

Truss handles the painful parts of microservices, freeing you to focus on the business logic.

Please note that Truss is currently pre-release software, and may change drastically with no notice. There is no versioning, no guarantees, no stability at this time. However, if you want to play around, make suggestions, or submit changes, we welcome issues and pull requests!

Install

Currently, there is no binary distribution of Truss, you must install from source.

To install this software, you must:

1. Install the standard C++ implementation of protocol buffers from https://developers.google.com/protocol-buffers/
2. Of course, install the Go compiler and tools from https://golang.org/. See https://golang.org/doc/install for details or, if you are using gccgo, follow the instructions at https://golang.org/doc/install/gccgo
3. Install the protoc-gen-go and proto packages for Go. The simplest way is to run go get -u github.com/golang/protobuf/{proto,protoc-gen-go}. The compiler plugin, protoc-gen-go, will be installed in $GOBIN, defaulting to $GOPATH/bin. It must be in your $PATH for the protocol compiler, protoc, to find it.
4. Install the gRPC: $ go get -u google.golang.org/grpc
5. Install Truss with $ go get -u github.com/TuneLab/go-truss/...

Usage

Using Truss is easy. You define your microservice in a protobuf file, and Truss uses that definition to create an entire microservice.

Once you've written the definition of your microservice, use the command $ truss {NAME_OF_PROTO_FILE} to generate your microservice into a directory called NAME-service/ within your current directory where NAME is the package name of your service.

See USAGE.md for details

Developing

See DEVELOPING.md for details