Browser Extension for tracking your time with Zoho People

This is an unofficial Browser Extension for tracking your time with Zoho People.

Download the extension here:

• Chrome
• Firefox
• Safari coming soon

Features

• Authentication with Zoho
• Search for Jobs and start a timer
• Pause and resume a timer

⚠️ Authentication uses a serverless function that is managed on a best effort basis by Inheaden. ⚠️

Development

Procedures:

1. Check if your Node.js version is >= 14.
2. Clone this repository.
3. Change the package's name, description, and repository fields in package.json.
4. Change the name of your extension on src/manifest.json.
5. Run npm install to install the dependencies.
6. Run npm start
7. Load your extension on Chrome following:
   1. Access chrome://extensions/
   2. Check Developer mode
   3. Click on Load unpacked extension
   4. Select the build folder.
8. Happy hacking.

Structure

All your extension's code must be placed in the src folder.

The boilerplate is already prepared to have a popup, an options page, a background page, and a new tab page (which replaces the new tab page of your browser). But feel free to customize these.

TypeScript

This boilerplate now supports TypeScript! The Options Page is implemented using TypeScript. Please refer to src/pages/Options/ for example usages.

Webpack auto-reload and HRM

To make your workflow much more efficient this boilerplate uses the webpack server to development (started with npm start) with auto reload feature that reloads the browser automatically every time that you save some file in your editor.

You can run the dev mode on other port if you want. Just specify the env var port like this:

yarn start

Content Scripts

Although this boilerplate uses the webpack dev server, it's also prepared to write all your bundles files on the disk at every code change, so you can point, on your extension manifest, to your bundles that you want to use as content scripts, but you need to exclude these entry points from hot reloading (why?). To do so you need to expose which entry points are content scripts on the webpack.config.js using the chromeExtensionBoilerplate -> notHotReload config. Look the example below.

Let's say that you want use the myContentScript entry point as content script, so on your webpack.config.js you will configure the entry point and exclude it from hot reloading, like this:

{
  …
  entry: {
    myContentScript: "./src/js/myContentScript.js"
  },
  chromeExtensionBoilerplate: {
    notHotReload: ["myContentScript"]
  }
  …
}

and on your src/manifest.json:

{
  "content_scripts": [
    {
      "matches": ["https://www.google.com/*"],
      "js": ["myContentScript.bundle.js"]
    }
  ]
}

Intelligent Code Completion

Thanks to @hudidit's kind suggestions, this boilerplate supports chrome-specific intelligent code completion using @types/chrome.

Packing

After the development of your extension run the command

$ NODE_ENV=production yarn build

Now, the content of build folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the official guide to more infos about publishing.

Resources:

• Webpack documentation
• Chrome Extension documentation
• Chrome boilerplate by Michael Xieyang Liu