Skip to content

bethanyj28/gomato-slack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gomato-slack

An open source slack pomodoro timer written in Go. This project is currently in development and is about halfway to a usable product. Please see upcoming tasks

Getting Started

On slack, create a bot user. Under Settings -> Basic Information, scroll to App Credentials and copy the Verification Token

Clone the repo, then run make env, which will generate a file called environment.env (which is ignored by git). You will need to enter your verification token on this line:

SLACK_VERIFICATION_TOKEN=<Your Slack verification token>

Run the server by running make build and make run which essentially runs:

docker build -t bethanyj28/gomato-slack .
docker run --rm -p 8080:8080 bethanyj28/gomato-slack

Install ngrok and run

ngrok http 8080

Copy the forwarding URL (the http one). On the Slack API homepage for your app, under Features -> Slash Commands, add the following commands mapped to the following endpoints (command names are suggestions):

/gomato_start -> <ngrok url>/timer/start (optional set duration)
/gomato_pause -> <ngrok url>/timer/pause
/gomato_resume -> <ngrok url>/timer/resume
/gomato_stop -> <ngrok url>/timer/stop

From here, you should be able to run those commands from your workspace! The commands are straightforward except for start, which has the option to set a duration. The default duration is 20 minutes

/gomato_start
/gomato_start 40

Upcoming Tasks

  • Confirm user input commands
  • Respond to user via Slack when timer is up
  • Option to set do not disturb during timer
  • Set a timer for a break

About

Slack integration utilizing the gomato package

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published