Skip to content

Latest commit

 

History

History
executable file
·
121 lines (90 loc) · 5.52 KB

README.md

File metadata and controls

executable file
·
121 lines (90 loc) · 5.52 KB
Raw
logo

Chrome Extension Boilerplate with
React + Vite + TypeScript + TailwindCSS

This is a side product of my Chrome Extension Supatabs. Supatabs is a 🔥🔥 BLAZINGLY FAST 🔥🔥 free alternative to OneTab with support for chrome tab groups and searching through tabs.
If you tend to have thousands of tabs open, are a OneTab user, or use any other tab manager make sure to check it out here!

Table of Contents

Intro

This boilerplate is meant to be a minimal quick start for creating chrome extensions using React, Typescript and Tailwind CSS.

Built for:

For improved DX and rapid building vite and nodemon are used.

Chrome does not accept manifest v2 extensions since Jan 2022, therefore this template uses manifest v3.

Firefox + other browsers don't yet support manifest v3, so cross browser usage is not encouraged.

  • Read more about Chrome manifest v2 support here.
  • Read more about Firefox Manifest v3 support here.

As soon as Firefox supports manifest v3, support will be added in this repo as well.

Oh by the way ... I also implemented a chrome local/sync storage hook for react, which works well with this template. Check it out here.

Why another boilerplate?

I have used webpack react boilerplates and found it too hard to configure.

Vite is mega easy to understand which makes it easier to get into and to maintain for others.

I couldn't find another minimal boilerplate for React, TypeScript and Tailwind CSS. So here it is.

Features

Usage

Setup

  1. Clone this repository｀
  2. Change name and description in manifest.json
  3. Run yarn or npm i (check your node version >= 16)
  4. Run yarn dev or npm run dev
  5. Load Extension in Chrome
    1. Open - Chrome browser
    2. Access - chrome://extensions
    3. Tick - Developer mode
    4. Find - Load unpacked extension
    5. Select - dist folder in this project (after dev or build)
  6. If you want to build in production, Just run yarn build or npm run build.

Customization

The template includes all of the Chrome extension pages. You will likely have to customize it to fit your needs.

E.g. you don't want the newtab page to activate whenever you open a new tab:

  1. remove the directory newtab and its contents in src/pages
  2. remove chrome_url_overrides: { newtab: 'src/pages/newtab/index.html' }, in manifest.json

If you need to declare extra HTML pages beyond those the manifest accommodates, place them in the Vite config under build.rollupOptions.input.

This example includes a welcome page to open when the user installs the extension.

CSS files in the src/pages/* directories are not necessary. They are left in there in case you want to use it in combination with Tailwind CSS. Feel free to delete them.

Tailwind can be configured as usual in the tailwind.config.cjs file. See doc link below.

Publish your extension

To upload an extension to the Chrome store you have to pack (zip) it and then upload it to your item in entry in the Chrome Web Store.

This repo includes a Github Action Workflow to create a optimized prod build and create the zip file.

To run the workflow do the following:

  1. Go to the "Actions" tab in your forked repository from this template
  2. In the left sidebar click on "Build and Zip Extension"
  3. Click on "Run Workflow" and select the main branch, then "Run Workflow"
  4. Refresh the page and click the most recent run
  5. In the summary page "Artifacts" section click on the generated "vite-web-extension"
  6. Upload this file to the Chrome Web Store as described here

Tech Docs

Credit

Heavily inspired by Jonghakseo's vite chrome extension boilerplate. It uses SASS instead of TailwindCSS if you want to check it out.

Contributing

Feel free to open PRs or raise issues!