butterrobot/docs/contributing.md
Felipe M. 7c684af8c3
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
refactor: python -> go
2025-04-20 14:13:44 +02:00

510 B

Contributing

To run the project locally you will need Go 1.19 or higher.

git clone git@github.com:fmartingr/butterrobot.git
cd butterrobot
make setup
make build

Create a .env-local file with the required environment variables, you have an example file.

SLACK_TOKEN=xxx
TELEGRAM_TOKEN=xxx
HOSTNAME=myhostname.com
...

And then you can run it directly:

# Run directly with Go
go run ./cmd/butterrobot/main.go

# Or run the built binary
./bin/butterrobot