Track time on Toggl using a Flic Button
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 3 commits behind swissmanu:master.

README.md

flictoggl

Track time on Toggl using a Flic button.

Build Status js-standard-style Commitizen friendly npm version semantic-release

flictoggl connects a Flic smart button to your Toggl account for simple on/off time tracking. Hit the button to start recording time. Hit it again to stop. Simple as pie.

Requirements

  • NodeJS

Use with Flic Mobile App

You have to deploy flictoggl as an HTTP service in order to use it with the Flic mobile app.

Step 1: Deploy to Heroku

You can deploy flictoggl everywhere you want. This guide shows how you can do this using Heroku though.

git clone https://github.com/swissmanu/flictoggl.git
cd flictoggl
heroku create
git push heroku master

Make sure you note down the URL of the deployed Heroku app for later use in step 3.

Step 2: Configure Flic App

  • Open the Flic app on your phone
  • Add an HTTP Request action
  • Enter the URL of the deployed Heroku app from step 1
  • Select POST as request type
  • Paste the API token from step 2 to the Body field

Button Action

Step 3: Test drive!

  • Press your Flic button once for start recording time
  • Press the button again to stop recording
  • Check the Toggl web timer

Use with hax-with-flic

hax-with-flic runs executable scripts on your Mac upon pressing a connected Flic button. To attach flictoggl to hax-with-flic, install flictoggl as command line utility:

npm install -g flictoggl

You have to create a wrapper script around flictoggl to run it with hax-with-flic-osx. Example:

#!/bin/sh

# hax-with-flic is on a very early stage currently.
# Make sure the PATH env var contains the path to your NodeJS installation.
# flictoggl will not work otherwise.
export PATH=/path/to/node/js:$PATH
RESULT=`flictoggl [TogglAPIToken]`

# Uncomment for Goodie: Show Started/Stopped via OS X notification center:
# osascript -e "display notification \"$RESULT\" with title \"Toggl\""

Hook the script to hax-with-flic:

hax-with-flic


How to get your Toggl API Token

  • Login to your Toggl account
  • Go to your profile
  • Copy your API token from the very bottom of the page

License

Copyright (c) 2016 Manuel Alabor

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.