|
| 1 | +# TrektorUp |
| 2 | + |
| 3 | +A Trello Power-Up to integrate Trello cards into Toggl time tracking. |
| 4 | + |
| 5 | +## Usage |
| 6 | + |
| 7 | +### Configure Toggl API key |
| 8 | + |
| 9 | +To make use of TrektorUp, you first have to configure your personal Toggl API |
| 10 | +key. To do so, click on Trello Board Menu (Three dots in the upper right |
| 11 | +corner) -> Power-Ups -> Enabled -> Settings (Trektor) -> Edit Power-Up |
| 12 | +settings. |
| 13 | + |
| 14 | +### Create tracking task and start tracking |
| 15 | + |
| 16 | +Open a card. The card must have exactly one label starting with `#`, containing |
| 17 | +the corresponding Toggl project. The Toggl project have to exist. Look for the |
| 18 | +Power-Ups button section on the right side of the card. Click on "Trek now". |
| 19 | +Shortly after clicking, there will be a new card label named "Trekking", that |
| 20 | +shows the current tracking task. The Toggl task will be created if it does not |
| 21 | +exist. |
| 22 | + |
| 23 | +### Re-start existing tracking task |
| 24 | + |
| 25 | +you can also click on the Trekking label within the top section of the Trello |
| 26 | +card to start tracking. If there is no Trekking label, you first have to create |
| 27 | +the tracking task as shown bevore. |
| 28 | + |
| 29 | +## Hacking |
| 30 | + |
| 31 | +TrektorUp uses Vite/Rollup for development. |
| 32 | + |
| 33 | + git clone git@github.com:aboutsource/Trektor-Up.git |
| 34 | + cd Trektor-Up |
| 35 | + npm install |
| 36 | + |
| 37 | +### Build the Power-Ip |
| 38 | + |
| 39 | + npm run build |
| 40 | + |
| 41 | +If build successfully, there is a dist folder containing the Power-Up |
| 42 | + |
| 43 | +### Release a new version |
| 44 | + |
| 45 | +* Update version string in `package.json` |
| 46 | +* Push to github |
| 47 | +* Tag the repo with new version |
| 48 | +* Push tag |
| 49 | +* Github-Actions should run the Deploy job |
| 50 | + |
| 51 | +### Hosting and Deployment |
| 52 | + |
| 53 | +TrektorUp is hosted at https://trello.aboutsource.net right now. See also https://developer.atlassian.com/cloud/trello/guides/power-ups/building-a-power-up-part-one/#getting-started for hosting requirements. |
| 54 | + |
| 55 | +WARNING: The hosting domain has to be manually whitelisted by the Toggl support team. Otherwise, there are no corresponding CORS headers when accessing the Toggl API. See also https://github.com/toggl/toggl_api_docs/blob/master/chapters/cors.md |
0 commit comments