Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
sql
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

TeaTime

AppVeyor AppVeyor tests Docker Pulls 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

  1. Create a group called tea

    /teatime groups add tea
    
  2. Add some options to your group

    /teatime options add tea "Earl Grey"
    /teatime options add tea "English Breakfast"
    
  3. Start a new round of tea

    /teatime tea
    

    image

  4. Wait for everyone to join...

    (for those who like commands)

    /teatime join "Earl Grey"
    

    image

  5. (optional) Be a good sport and volunteer to make the round

    /teatime illmake
    

    image

  6. End the round

    /teatime end
    

    image

  7. 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:
      SLACK__VERIFICATIONTOKEN: helloworld
      MYSQL__HOST: localhost
      MYSQL__USERNAME: username
      MYSQL__PASSWORD: password

Supported tags

  • latest
  • dev

Environment Variables

Variable Required Description
SLACK__VERIFICATIONTOKEN true The verification token used to verify slack messages
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

License

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