Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elforastero/react-browser-extension-boilerplate

🎉 React / Preact X browser extension boilerplate for the most popular browsers (Chrome, Firefox, Opera, new Edge and other Chromium-based browsers)
https://github.com/elforastero/react-browser-extension-boilerplate

boilerplate browser-extension chrome-extension chrome-extension-react chrome-extension-starter firefox-extension opera-extension preact-browser-extension preact-chrome-extension react-browser-extension react-browser-extension-boilerplate react-chrome-extension

Last synced: about 1 month ago
JSON representation

🎉 React / Preact X browser extension boilerplate for the most popular browsers (Chrome, Firefox, Opera, new Edge and other Chromium-based browsers)

Awesome Lists containing this project

README 

        
React Web Extension Boilerplate




  

  

    Documentation

  

  

    Maintenance

  

  

    License: MIT

  




> This project aims to provide a simple boilerplate for writing browser extensions for the most popular browsers, such as Chrome, Firefox, Opera, new Edge and other Chromium-based browsers.



![React Web Extension Boilerplate](logo.png)



## 🎉 Features



- **Preact X or React** (you can switch them easily in webpack config)

- **Shadow DOM** for injected content

- **Styled-Components**

- **Auto reloading** (there's no need to manually reload extension)

- Ready-to-go setup with **internationalization**



## 👨‍💻 Examples



You can look at:



- [Framer](https://github.com/ElForastero/framer): a todo list extension as an example of using this boilerplate.

- [Good Block](https://github.com/LucasAndrad/block-sites-react-extension): an extension to block websites, also using this boilerplate.

- [ScreenplaySubs](https://github.com/SMASH-CUT/extension): an extension to watch movies in Netflix with screenplays, in sync. Also using this boilerplate.



There are no straight restrictions on how to use it, or any limitations on tools and technologies. Think of it as a regular react application with some special properties.



## 📝 Description



It's built with `preact` and `preact-compat` which allows you to switch between `react` and `preact`.



Content and styles which are injected directly to the page, are isolated inside Shadow DOM.



## 🏁 Install



```sh

git clone [email protected]:ElForastero/react-browser-extension-boilerplate.git 

```



## 🚀 Usage



```sh

yarn watch

```



Runs webpack in watch mode. Automatically reloads the page after changes in files. Thanks to [webpack-extension-reloader](https://github.com/rubenspgcavalcante/webpack-extension-reloader).



```sh

yarn build

```



Builds the extension in production mode. This version can be shipped to the store.



## How to increment version



Use [npm version](https://docs.npmjs.com/cli/version) cli command to bump a version of your package.json. The version of manifest will stay in sync with version specified in package.json.



For example:



```sh

npm version patch

```



This will increase your patch package.json version. During the next build output manifest file will have the same version.



## ⚠️ Content Security Policy (CSP)

"unsafe-eval" in directive "script-src" and "connect-src" are needed for auto reloading, and should be removed from production manifest.json.



## 💻 Useful links



- [Manifest File Format](https://developer.chrome.com/apps/manifest)

- [Content Security Policy (CSP)](https://developer.chrome.com/extensions/contentSecurityPolicy)

- [Chrome i18n](https://developer.chrome.com/extensions/i18n)

- [Porting a Google Chrome extension to Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Porting_a_Google_Chrome_extension)

- [Firefox add-ons examples](https://github.com/mdn/webextensions-examples)

- [exthouse - tool for performance testing](https://github.com/treosh/exthouse)

- [webext-redux - a set o utilities to use redux in web extensions](https://github.com/tshaddix/webext-redux)

- [webpack-manifest-version-sync-plugin](https://github.com/ElForastero/webpack-manifest-version-sync-plugin)



## 🤝 Show your support



Give a ⭐️ if this project helped you!



## 📝 License



Copyright © 2019 [Eugene Dzhumak](https://github.com/ElForastero).


This project is [MIT](https://github.com/ElForastero/react-browser-extension-boilerplate/blob/master/LICENSE) licensed.



***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_