Installation

Follow these detailed steps to clone and set up the ChromeQuick repository on your local machine. This guide ensures that you have a smooth start to developing your Chrome extension with ChromeQuick.

Overview

Setting up your development environment correctly is crucial for a successful Chrome extension project. This installation guide is designed to help you clone the ChromeQuick repository, install necessary dependencies, build the project, and load it into Chrome for testing and development. Each step is explained with clarity to ensure you can start developing with confidence.

Cloning and Setting Up ChromeQuick

To begin using ChromeQuick, you will first need to clone the repository and install the necessary dependencies. Here's how you can do it:

Step 1: Clone the Repository

Open your terminal and run the following command to clone the ChromeQuick repository:

git clone https://github.com/ChromeQuick/chromequick.git

cd ChromeQuick

Step 2: Install Dependencies

Once you have cloned the repository and navigated into the project directory, you need to install its dependencies. You can use npm or yarn for this purpose. Depending on your preference, run one of the following commands:

Using npm:

npm install

Using yarn:

yarn install

Step 3: Build the Project

Before you can load your Chrome extension, you need to build the project to compile the source files into a format that Chrome can load as an extension:

Using npm:

npm run build

Or if you are using yarn:

yarn build

This command will generate a dist folder in your project directory containing all the packaged extension files.

Step 4: Load the Unpacked Extension

After building the project, follow these steps to load your unpacked extension into Chrome:

  1. Open Chrome: Start Google Chrome and navigate to the Extensions page by entering chrome://extensions/ in the address bar.
  2. Enable Developer Mode: At the top right of the Extensions page, toggle the "Developer mode" switch to the on position.
  3. Load Unpacked Extension: Click the "Load unpacked" button that appears after enabling Developer Mode. A file dialog will open.
  4. Select the dist Folder: Navigate to the dist folder within your ChromeQuick project directory, select it, and click "Open". Chrome will load your extension from this folder.

Step 5: Verify the Installation

To ensure your extension is installed and running:

  • You should now see your ChromeQuick extension in the list of extensions on the chrome://extensions/ page.
  • Click the extension icon in the Chrome toolbar to open it. Click the pin icon to pin it to the toolbar.

Next Steps

With ChromeQuick successfully installed and loaded in your browser, you can begin developing and testing your Chrome extension. Make sure to use Chrome's developer tools to debug and refine your extension.

This updated installation guide provides a clear, step-by-step process that not only helps in setting up ChromeQuick but also in getting the extension up and running in your Chrome browser.