brianium / tomaat

:tomato: Slack integrated pomodoro timer... with Electron + ClojureScript!

Tomaat

An electron app written in ClojureScript. Integrates with Slack to let people know you are doing great things! Uses reagent for the UI.

Features

• 25 minute pomodoro timer
• Update Slack profile with tomato while pom is in progress
• Send a Slack notification when pomodoro is complete
• Pause Slack notifications while pomodoro is running
• Play a sound when time is up (useful if Slack is not configured)
• Timer visible in tray!

Slack usage is optional, but if configured - your profile will be updated like so:

Tomaat currently relies on legacy-tokens to facilitate a simple text field entry of a slack token. Some day when the sun goes out and Slack deprecates these, then we will look into building a view for authentication.

Development

Tomaat uses lein-figwheel for hot reloading of all source files. Since Tomaat leverages electron apis across the board - all builds target :nodejs.

To start development process:

$ lein start
$ lein electron

Note: figwheel requires the ws node module for node targets. I opted to install this globally:

$ npm install -g ws

Project structure

All source files are under src/tomaat, and several build targets are laid out in project.clj. Tomaat follows a structure that allows for the main electron process, a renderer process, and a worker process.

The worker process runs as an invisible window for the purpose of running the timer, persisting config, and interacting with slack.

Building

Tomaat is packaged using electron-packager. It has currently only been built and tested on macOS.

Just use make to build Tomaat.

$ make

Todo

• webview for fetching slack token
• test and build for other operating systems

tomaat's Issues

Slack notification not respecting config

The slack notification is always being attempted. The worker function notify is not checking stored settings to see if it should send to slack

Audio only plays once

I think the audio only plays once if doing multiple pom sessions. I believe the audio element needs to be reloaded for each subsequent play. Guessing a single audio reference needs to be maintained, and loaded before each play.

i.e something like

(.load audio)
(.play audio)

Settings UI is displayed on the front UI

A picture is worth a thousand words.

upgrade electron version

GitHub has helpfully informed me that the electron version being used has a security vulnerability - should probably update the electron version :)

Update readme with URL for legacy tokens until `webview for fetching slack token` is completed

https://api.slack.com/custom-integrations/legacy-tokens