👋Get Started

Install

Once you purchase ChromeKit, you will be provided access to a few Github repositories. To start using the npx commands, you will have to do a few things first.

1. You will have to add a SSH Key to your Github account. If you already have one added, you are good and can skip the next few steps. If not, please continue to the next step.

2. Generate a new SSH Key if you don't have one in your laptop already.

3. Now add the SSK Key to your Github account.

That's it! This is a one time setup and you don't have to do it again on the same machine.

Develop

Choose the type of extension you want to build. You can checkout the types offered by ChromeKit

🔬Chrome Extension Types

Once you have a chosen a type, go to the corresponding page under initialise category in the docs.

Common setup:

For content-script, content-script-sidebar, popup & side-panel run the below

npm run watch

This command will compile your JS code and adds it to the extension directory.

To load the extension in your browser, do the following

1. Navigate to chrome://extensions

2. Enable developer mode (Ignore if already enabled)

3. Click on Load Unpacked

4. Select the extension directory

5. To check the logs, click on service worker of your extension from chrome://extensions page. Here you can check the logs for background/service worker. Logs from content scripts will be shown in the individual tabs developer console. To check popup logs, open the extension popup, right click in the popup and select inspect. Go to console to see the popup logs.