Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bfontaine/stargazer

:star2: A bot that watches stars on Slack so you don’t have to
https://github.com/bfontaine/stargazer

bot go slack

Last synced: about 1 month ago
JSON representation

:star2: A bot that watches stars on Slack so you don’t have to

Awesome Lists containing this project

README

        

# Stargazer

**Stargazer** is a Slack bot that watches for stars on your messages and report
them to you.

![](imgs/starred-msg.png)

[![Build Status](https://travis-ci.org/bfontaine/stargazer.svg)](https://travis-ci.org/bfontaine/stargazer)

## Build

go get github.com/bfontaine/stargazer

## Run

$ TOKEN=your-slack-token stargazer

## FAQ

### How do I get a token?

1. Go on your team’s Slack URL, and on the “Integrations” page, search for the
“bots” integration. If your team is e.g. `foobar`, the URL is
`https://foobar.slack.com/services/new/bot`.
2. Choose a name for your bot. Don’t worry, you can change it later.
![](imgs/create-bot.png)
3. Your token is on the bot page.
![](imgs/token.png)

## How do I get the bot to report stars to me?

The bot works with a whitelist, not to annoy everybody by default. Send it a
private message saying “enable”, and it should enable the reporting for you.

![](imgs/enable.png)

You can later disable this by sending it “disable”.

## Hacking

**Stargazer** doesn’t currently have a public API. You can however contribute
to this repository :)

Make sure tests pass with the following command:

$ STARGAZER_TESTING=1 go test ./...