Git Product home page Git Product logo

browser-extension's Introduction

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:
9. 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

browser-extension's People

Contributors

aleksadoderovic avatar aleksandar-olic avatar alexknutson avatar annsk avatar bojan-cvijanovic avatar caioportela avatar cedomirm1990 avatar cpinto avatar dpoetzsch avatar esjch2020 avatar gheithen avatar ivanmijatovic89 avatar michalmatoga avatar milosfromcake avatar mistreanuionutcosmin avatar mitchcapper avatar mrdevver avatar mrezzamoradi avatar necatimeral avatar nederby avatar orange1337 avatar rilindfetoshi avatar ritchiefarr avatar senti-mark-monteiro avatar sitehost-ops avatar slavkoparcoing avatar stefancoing avatar txdfrancesco avatar vivi90 avatar wirduzen-felix avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.