README.md

Chrome Extension Boilerplate with
React + Vite + TypeScript

This project is listed in the Awesome Vite

This project is cloned from https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite/commit/ca3321663ad0cbb96329338de68061250dca3cd7#diff-41c0d7470bfc7b681a2074bb6c8e6d8356b7cfd44e45e8b0d41cce661ea7b982

Table of Contents

• Intro
• Features
• Installation
  • Procedures
• Screenshots
  • NewTab
  • Popup
• Sample
• Documents

Intro

This boilerplate is made for creating chrome extensions using React and Typescript.

The focus was on improving the build speed and development experience with Vite.

Features

• React 18
• TypeScript
• Jest
• React Testing Library
• Vite
• SASS
• Tailwind CSS
• ESLint
• Prettier
• Chrome Extension Manifest Version 3
• HRR(Hot Rebuild & Refresh/Reload)

Installation

Procedures

1. Clone this repository.
2. Change name and description in package.json => Auto synchronize with manifest
3. Run yarn install or npm i (check your node version >= 16.6, recommended >= 18)
4. Run yarn dev or npm run dev
5. Load Extension on Chrome
   1. Open - Chrome browser
   2. Access - chrome://extensions
   3. Check - 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.

Screenshots

New Tab

Popup

Sample

• https://github.com/Jonghakseo/drag-gpt-extension
• https://github.com/Jonghakseo/pr-commit-noti

Documents

• Vite Plugin
• ChromeExtension
• Rollup
• Rollup-plugin-chrome-extension

Star History

---

Thanks To

Jetbrains	Jackson Hong

---

Jonghakseo