Clockify extension for Chrome and Firefox

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

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

Make sure you have Node, NPM, Ruby, and Compass installed on your system (see setup instructions below)
Clone the repository git clone git@github.com:clockify/browser-extension.git
Run npm install
Build Chrome extension by running:
Linux: npm run compile.dev.chrome
Windows: npm run compile.dev.chrome.win
Navigate to chrome://extensions/
Enable "Developer mode" (located in the top right corner)
Click "Load unpacked" and select the www/chrome.dev/ folder that you've built

Firefox extension

Make sure you have Node, NPM, Ruby, and Compass installed on your system (see setup instructions below)
Clone the repository git clone git@github.com:clockify/browser-extension.git
Run npm install
Build Firefox add-on by running:
Linux: npm run compile.dev.firefox
Windows: npm run compile.dev.firefox.win
Navigate to about:debugging
Click "Load Temporary Add-on"
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 apt-get install ruby-dev
sudo gem install compass
sudo npm install

Setup (Windows)

Install/Update Node.js to Latest: https://nodejs.org/en/download/
Install Ruby: https://rubyinstaller.org/downloads/

> gem install compass
> npm install

Setup (Mac)

brew install rbenv ruby-build
sudo gem install compass
sudo npm install
npm install @popperjs/core

Compile

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

Compile (Windows)

> npm run compile.dev.chrome.win
> npm run compile.dev.firefox.win

cmrd-senya/browser-extension