truss/README.md

Truss

Truss handles the painful parts of services, 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 protoc 3 or newer. The easiest way is to download a release from github and add to $PATH. Otherwise install from source.

2. Install the proto and protoc-gen-go packages. (protoc-gen-go must be in $PATH)

   go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
   

3. Install HTTP Annotations

   go get -u google.golang.org/genproto
   

4. Install Truss with

   go get -u github.com/TuneLab/go-truss/...
   

Usage

Using Truss is easy. You define your service with gRPC and protoc buffers, and Truss uses that definition to create an entire service. You can even add http annotations for HTTP 1.1/JSON transport!

Then you open the handlers/server/server_handler.go, add you business logic, and you're good to go.

Here is an example service definition: Echo Service

Try Truss for yourself on Echo Service to see the service that is generated:

truss _example/echo.proto

See USAGE.md and TUTORIAL.md for more details.

Developing

See DEVELOPING.md for details.