Code Monkey home page Code Monkey logo

react-browser-extension-boilerplate's Introduction

React (Preact) Browser Extension Boilerplate

Documentation Maintenance License: MIT Twitter: el4astero

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.

๐ŸŽ‰ Features

  • Preact X or React (by default Preact - lightweight React alternative)
  • Shadow DOM for injected content
  • CSS Modules
  • PostCSS (preset-env and custom-properties)
  • Auto reloading
  • Ready-to-go setup with internationalization

๐Ÿ“ 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. CSS modules are used to avoid class names collision.

Example

๐Ÿ Install

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

๐Ÿš€ Usage

yarn watch

Runs webpack in watch mode. Automatically reloads the page after changes in files.

yarn build

Builds the extension in production mode.

โš ๏ธ Note on Content Security Policy (CSP)

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

๐Ÿ’ป Useful links

๐Ÿ‘จโ€๐Ÿ’ป Author

๐Ÿ‘ค Eugene Dzhumak

๐Ÿค Show your support

Give a โญ๏ธ if this project helped you!

๐Ÿ“ License

Copyright ยฉ 2019 Eugene Dzhumak.
This project is MIT licensed.


This README was generated with โค๏ธ by readme-md-generator

react-browser-extension-boilerplate's People

Contributors

baitun avatar elforastero avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.