shuowu / chrome-extension-react-starter-kit

chrome extension react starter kit

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Chrome extension react starter kit

This repo is a starter kit for chrome extension using React tech stack. It includes demo code for popup, content script and backgroud pages of the demo extension.

The content script will display a fixed top header in red background color for all webpages.

Pros

  1. Automatically chrome extension auto reload when code changes
  2. Automatically web page refresh for current tab (For content script development)
  3. Write code with latest frontend techs, code will be transpiled with webpack
  4. Sourcemap enabled for easy debugging
  5. Leverage React-jss to avoid style confliction between webpage and extension
  6. Eslint enabled

Get Started

  1. $ yarn install
  2. $ yarn start to start webpack dev server
  3. Load unpacked extension: Open chrome browser -> chrome://extensions -> Load unpacked
  4. Change code in ./src/background, ./src/content-script, ./src/popup based on your business logic
  5. The webpack dev server is configable in webpack.{env}.config.js
  6. $ yarn build to build production code

License

MIT

About

chrome extension react starter kit


Languages

Language:JavaScript 93.9%Language:HTML 6.1%