A simple chrome extension boilerplate made in React

Simple Chrome extension React boilerplate

This is a simple chrome extension boilerplate made in React to use as a default structure for your future project.
The purpose is to provide as basic and as useful as possible basic structure to get started as quick as possible.

Of course, some parts may not suits you, but most of the basic redundant work is already done.

Usage

  • yarn dev: runs webpack with development environment.
  • yarn build: runs webpack with production environment.
  • yarn lint: checks typescript files lint issues in the src/ folder.

Installation

Note that you need at least yarn or npm installed to proceed.

Clone repo

git clone https://github.com/yafkari/chrome-extension-react-boilerplate.git

Move to chrome-extension-react-boilerplate directory and run

yarn install

Now you can either build the extension with

yarn build

or run it in dev mode

yarn dev

You will see a dist/ folder generated containing the build files.

yarn dev watches for file changes.

Features

  • React
  • Jest
  • Scss support

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request ?

License

The repo is available as open source under the terms of the MIT License.

GitHub

View Github