butterrobot/docs/contributing.md
Felipe M. 29538b7d63
All checks were successful
CI / format (push) Successful in 1m50s
CI / lint (push) Successful in 3m0s
CI / goreleaser-lint (push) Successful in 10s
CI / test (push) Successful in 1m35s
CI / build (push) Successful in 1m35s
chore: remove Slack platform support
Slack was always marked as untested and is being dropped, leaving
Telegram as the sole supported platform.

- Delete the internal/platform/slack connector package
- Remove Slack registration in the platform factory
- Remove SlackConfig and its SLACK_TOKEN env vars from config
- Scrub Slack from README, docs, and .env examples
- Drop incidental Slack references from the gallerydl plugin copy

Also fixes a pre-existing staticcheck SA5011 warning in db_test.go
so the tree lints cleanly.
2026-07-06 07:52:31 +02:00

28 lines
494 B
Markdown

## Contributing
To run the project locally you will need Go 1.19 or higher.
```bash
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](.env-example).
```
TELEGRAM_TOKEN=xxx
HOSTNAME=myhostname.com
...
```
And then you can run it directly:
```bash
# Run directly with Go
go run ./cmd/butterrobot/main.go
# Or run the built binary
./bin/butterrobot
```