TeaTime ☕

GitHub

TeaTime is the Russian Roulette of tea making (although not strictly limited to tea).

Overview

TeaTime allows your teams to start a round of tea, join with their choice of tea, and (on round end) randomly select someone to make the round of tea.

Slack

Commands

Description	Command
Show a list of available commands	`/teatime help`
Start a new round	`/teatime {group}`
Join a round	`/teatime join {option}`
End a round	`/teatime end`
Volunteer to make the round	`/teatime illmake`

Groups

Description	Command
Add a group	`/teatime groups add {name}`
Remove a group	`/teatime groups remove {name}`

Options

Description	Command
Add a new option for a group	`/teatime options add {group} {name}`
Remove an option from a group	`/teatime options remove {group} {name}`

Example Usage

Create a group called tea
```
 /teatime groups add tea
```

Add some options to your group

 /teatime options add tea "Earl Grey"
 /teatime options add tea "English Breakfast"

Start a new round of tea
```
 /teatime tea
```
Wait for everyone to join…

(for those who like commands)
```
 /teatime join "Earl Grey"
```
(optional) Be a good sport and volunteer to make the round
```
 /teatime illmake
```
End the round
```
 /teatime end
```
Congratulations?

Running

Docker

The TeaTime docker image can be found on Docker Hub.

An example docker-compose.yml

version: '3'
services:
  web:
    image: dockdockcontainer/teatime:latest
    restart: always
    ports:
     - "80:80"
    environment:
      SELFHOST: https://demo.example
      MYSQL__HOST: localhost
      MYSQL__USERNAME: username
      MYSQL__PASSWORD: password
      SLACK__OAUTH__ENABLED: true
      SLACK__OAUTH__CLIENTID: demoid
      SLACK__OAUTH__CLIENTSECRET: demosecret
      SLACK__REQUESTVERIFICATION__ENABLED: true
      SLACK__REQUESTVERIFICATION__SIGNINGSECRET: secret

Supported tags

latest
dev

Environment Variables

Variable	Required	Description
SELFHOST	false	The host of the TeaTime application including the scheme, host and port. If not set, this will be generated from the request. Eg `https://runteatime.com`
MYSQL__HOST	true	The mysql server host.
MYSQL__PORT	false (default `3306`)	The mysql server port.
MYSQL__USERNAME	true	The mysql users username.
MYSQL__PASSWORD	true	The mysql users password.
MYSQL__DATABASE	false (default `teatime`)	The mysql database.
SLACKOAUTHENABLED	false (default `false`)	Set to `true` to enable the “Add to Slack” button”.
SLACKOAUTHCLIENTID	true if enabled	The “Client ID” for the Slack app.
SLACKOAUTHCLIENTSECRET	true if enabled	The “Client Secret” for the Slack app.
SLACKREQUESTVERIFICATIONENABLED	false (default `false`)	Set to `true` to enable Slack request verification
SLACKREQUESTVERIFICATIONSIGNINGSECRET	true if enabled	The “Signing Secret” for the Slack app.

License

This project is licensed under the MIT License - see the LICENSE file for details