Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 1.74 KB

README.md

File metadata and controls

70 lines (44 loc) · 1.74 KB
Raw

React TypeScript + Vite Chrome Extension Starter

build

react-vite-chrome-extension

This project is a boilerplate for creating a Google Chrome Extension with React + Vitejs + TailwindCSS + TypeScript.

💡 Preview

react-vite-chrome-extension

📦 Requirements

  • Nodejs v18+ LTS

⚛️ Development

  • Clone this repository
git clone https://github.com/timelessco/react-vite-chrome-extension
  • Install dependencies
pnpm install
  • Start Development Server
pnpm dev

💻 Production

  • Building the chrome extension for production
pnpm build

🚀 Usage

  • You can find the chrome extension contents in the dist folder
  • Open chrome://extension and turn on Developer Mode.
  • Click the Load unpacked extension button.
  • Now, select the dist folder.
  • Your extension is ready to use.

🍔 Additional Details

  • This boilerplate can be extended even further using Chrome Extension APIs
  • You can use Content Scripts to inject content into the page or accessing the DOM conent.
  • By using the Message Passing API, you can communicate with the content script and the popup.

💚 Message

I hope you find this useful. If you have any questions, please create an issue.

🎓 License

  • MIT