Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.96 KB

README.md

File metadata and controls

79 lines (55 loc) · 2.96 KB
Raw

Chrome Extension (MV3) Boilerplate with React 18 and Vite 5

This repository contains a boilerplate for building Chrome Extensions with React 18, TypeScript, and Vite 5. This boilerplate is inspired by and adapted from chrome-extension-boilerplate-react.

Features

This is a basic Chrome Extensions boilerplate to help you write modular and modern Javascript code and load CSS easily. This boilerplate is using:

Please open up an issue to nudge me to keep the npm packages up-to-date.

Installing and Running

Procedures:

  1. Check if your Node.js version is >= 18.
  2. Clone this repository.
  3. Change the package's name, description, and repository fields in package.json.
  4. Change the name of your extension in manifest.json.
  5. Run yarn install to install the dependencies.
  6. Run yarn build
  7. Load your extension on Chrome following:
    1. Access chrome://extensions/
    2. Turn the Developer mode switch on (top right corner)
    3. Click on Load unpacked
    4. Select the dist 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, a background script, and a content script. This example Chrome extension implements logic which lets the user scrape the page title. It was done so to demonstrate some of the chrome API functionality.

TypeScript

This boilerplate supports TypeScript! Everything that can be written in TypeScript is written in TypeScript.

Change Watchers

This boilerplate has a watch script (yarn watch) which will update the extension's code every time you save a file.

Packing

After the development of your extension run the command

$ yarn build

Now, the content of dist 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:

Tomasz Kiljańczyk | Website