Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/snwfdhmp/create-react-chrome-extension

Chrome / Firefox extension template using React and state-of-the-art settings.
https://github.com/snwfdhmp/create-react-chrome-extension

boilerplate chrome-extension create-react-app firefox-extension template template-repository

Last synced: 3 months ago
JSON representation

Chrome / Firefox extension template using React and state-of-the-art settings.

Awesome Lists containing this project

README

        

# create-react-chrome-extension

create-react-chrome-extension is a template for building Chrome and Firefox extensions using React and state-of-the-art settings. This project aims to provide a solid starting point for developers looking to create browser extensions with modern web technologies.

Consider giving it a ⭐️ if you like it to show your support!

## Features

- **React**: Build your extension's UI with the popular JavaScript library.
- **State-of-the-art settings**: The template is configured with the latest best practices in mind.
- **Support for Chrome and Firefox**: Develop extensions that are compatible with two of the most widely used web browsers.

## Getting Started

To use this template, clone the repository to your local machine:

```bash
git clone https://github.com/snwfdhmp/create-react-chrome-extension.git
```

Then, navigate into the project directory and install the dependencies:

```bash
cd create-react-chrome-extension
yarn install
```

Then you can build the app:

```bash
yarn build
```

Then install the unpacked extension from `dist` folder in Chrome ([tutorial](https://github.com/web-scrobbler/web-scrobbler/wiki/Install-an-unpacked-extension)) or Firefox ([tutorial](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#installing)).

## Development

For live reload development, use

```bash
yarn dev
```

## Contributing

Contributions are welcome! Please feel free to submit a pull request.

## License

This project is open source and available under the [MIT License](LICENSE).