search

clockify / browser-extension

Clockify Browser Extension
https://clockify.me/chrome-time-tracking
BSD 3-Clause "New" or "Revised" License
182 stars 167 forks source link

readme

Clockify extension for Chrome and Firefox

Insert Clockify's "Start timer" button to any web page.

About Clockify →

List of integrations →

Add your own integration

Want to create an integration or improve an existing one? Awesome! Adding an integration is super easy. You need basic web programming skills (HTML, Javascript, Git) and can be done in a couple of hours.

Just fork the repo, make your changes, and send us a pull request.

Something needs fixing?

Create an issue here on Github and our team will take a look the first change we get (which may take a few days, depending on our workload).

If you need the fix quicker, feel free to update the integration yourself and send us a pull request. We typically take care of them within a few days.

Building and testing

Chrome extension

  1. Make sure you have Node and NPM installed on your system (see setup instructions below)

  2. Clone the repository

  3. Run npm install --legacy-peer-deps

  4. Build Chrome extension by running:
    npm run compile.dev.chrome

  5. Navigate to chrome://extensions/

  6. Enable "Developer mode" (located in the top right corner)

  7. Click "Load unpacked" and select the www/chrome.dev/ folder that you've built

Firefox extension

BUILDING THE PRODUCTION VERSION

  1. Make sure you have Node and NPM installed on your system (see setup instructions below)
  2. Clone the repository
  3. In project root run npm install --legacy-peer-deps
  4. Build Firefox add-on by running: npm run compile.prod.firefox
  5. Zip the contents of the /firefox folder
  6. Navigate to about:debugging#/runtime/this-firefox
  7. Click "Load Temporary Add-on"
  8. Select the zipped file

    The extension is now built and loaded into firefox successfully

if you wish to play around with functionality:

  1. Proceed to login/signup 10.You are either redirected to the clockify web to login or if you're already logged in to the web version, then extension will instantly log you in once you've pressed the login button. Open some website (eg. some random Gitlab issue https://gitlab.com/gitlab-org/gitlab/-/issues/220296) 12. "Start timer" will appear, which you can click and the add-on will pick up the issue name and start the timer 13. Stop timer to save the time entry

BUILDING THE DEVELOPMENT VERSION

  1. Make sure you have Node and NPM installed on your system (see setup instructions below)

  2. Clone the repository

  3. Run npm install --legacy-peer-deps

  4. Build Firefox add-on by running: npm run compile.dev.firefox

  5. Navigate to about:debugging

  6. Click "Load Temporary Add-on"

  7. Select the www/firefox.dev/manifest.json file

How adding an integration works

Add the url of the new tool in /src/integrations/integrations.json. Then, create a /src/integrations/myapp.js file. It in, define where the button appears and from which element it needs to pick up the description field.

When the extension recognizes that you're on that url, it will load the necessary script.

If you need an example, you can see how Trello is implemented.

Use createButton() so both the icon and "Start timer" is displayed. If there's not enough space, you can use createSmallButton (so only the icon is displayed).

Before sending us a pull request, make sure you test the integration in both Chrome and Firefox.

Setup (Ubuntu)

sudo apt-get install nodejs
sudo npm install --legacy-peer-deps

Setup (Windows)

> npm install --legacy-peer-deps

Setup (Mac)

sudo npm install --legacy-peer-deps
npm install @popperjs/core

Compile

npm run compile.dev.chrome
npm run compile.dev.firefox