spriteful

Modernized to work with golang/dep

Modernized to work with Go Modules.

Spriteful

Spriteful is an HTTP API that provides server boot configuration for pixiecore.

See pixiecore.

Build or Install Spriteful

Installing

This will fetch Spriteful, its dependencies, and create the binary (essentially go get & go build in the one command). Make sure your $GOPATH is configured.

go install github.com/engineerang/spriteful

The Spriteful Binary can be found in your $GOPATH's bin/ directory.

If your $GOBIN is configured you should now be able to run:

spriteful -help

Building

go get github.com/engineerang/spriteful
go build $GOPATH/src/github.com/engineerang/spriteful/

Using Vendor Install Dependencies

As mentioned previously, this project has been forked to update the dependencies management now that gb is pretty much dead. golang/dep is now being used and dependencies can be installed by running the following:

You will need dep, Install instructions here.

Now using Go's in-built module dependency manager, go mod. If you'd like to download the dependencies to the vendor folder run:

git clone https://github.com/engineerang/spriteful.git
cd spriteful
go mod vendor

You should now see a '''vendor''' folder with all the dependencies installed.

Why didn't you commit the vendor directory like other Golang projects using dep i've seen?

Honestly, preference. For more information, see here.

Running

To run spriteful, use the following command:

spriteful -config /path/to/config/file

A sample config file is provided here.

pixiecore integration

To integrate with pixiecore, point the -api argument to this api:

$ pixiecore api http://{spritefulBindHost}:{SpritfulBindPort}/api