Welcome to Coffy Machine

This is the documentation for Coffy's web service.

Install

Reference binaries for different OS architectures here.

Clone the repo first:

git clone git@github.com:sven1103/coffy-machine.git

Then check the required Go version in ./go.mod (e.g. 'go 1.23'). Make sure you have the required Go version installed:

> go version  
go version go1.23.4 darwin/arm64

If not, visit the Go website and do so.

Coffy Machine uses swag for automated Swagger 2.0 documentation. So please install swag first:

go install github.com/swaggo/swag/cmd/swag@latest

and then run in the projects root directory:

swag init .

This should create a ./docs folder with this content:

.docs/
   docs.go
   swagger.json
   swagger.yaml

Then compile the source code with:

go build -o coffy-machine main.go

Then make it executable if not yet, e.g. under macOS or Linux:

chmod +x coffy-machine

You can just try to run the web service with the example configuration example_config.yaml:

./coffy-machine -c example_config.yaml

That's it 🚀