Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swissmanu/flictoggl
Track time on Toggl using a Flic Button
https://github.com/swissmanu/flictoggl
Last synced: 3 months ago
JSON representation
Track time on Toggl using a Flic Button
- Host: GitHub
- URL: https://github.com/swissmanu/flictoggl
- Owner: swissmanu
- License: mit
- Created: 2016-03-04T20:47:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-06T11:40:34.000Z (over 7 years ago)
- Last Synced: 2024-09-18T11:16:42.539Z (3 months ago)
- Language: JavaScript
- Size: 257 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# flictoggl
*Track time on [Toggl](https://www.toggl.com) using a [Flic](https://flic.io/) button.*
[](https://travis-ci.org/swissmanu/flictoggl) [](http://standardjs.com/) [](http://commitizen.github.io/cz-cli/) [](http://badge.fury.io/js/flictoggl) [](https://github.com/semantic-release/semantic-release)
`flictoggl` connects a [Flic](https://flic.io/) smart button to your [Toggl](https://www.toggl.com) 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](https://heroku.com) though.*
```bash
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
* Enter `apiToken=[token]` as `Body`, where `[token]` is to be replaced with the API token from step 2
### 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](https://github.com/50ButtonsEach/hax-with-flic-osx) 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:
```bash
npm install -g flictoggl
```
You have to create a wrapper script around `flictoggl` to run it with `hax-with-flic-osx`. Example:
```bash
#!/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`:
---
## How to get your Toggl API Token
* Login to your [Toggl account](https://www.toggl.com/app/profile)
* 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.