Skip to content

Commit

Permalink
đź“ť update readme.md (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jerembdn
jerembdn committed Nov 13, 2023
1 parent 9a663c2 commit 1e6bb10
Showing 1 changed file with 61 additions and 128 deletions.
189 changes: 61 additions & 128 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,42 +1,53 @@
<img src="src/assets/img/icon-128.png" width="64"/>

# Chrome Extension (MV3) Boilerplate with React 18 and Webpack 5

[![npm](https://img.shields.io/npm/v/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
[![npm-download](https://img.shields.io/npm/dw/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
[![npm](https://img.shields.io/npm/dm/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)

## Announcements

- Recently updated from **[React](https://reactjs.org)** ~~17~~ to **18**!
- **_This boilerplate adopts [Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)!_**
- For V2 users, please check out the [manifest-v2](https://github.com/lxieyang/chrome-extension-boilerplate-react/tree/manifest-v2) branch, or use version [3.x](https://www.npmjs.com/package/chrome-extension-boilerplate-react/v/3.3.0).
- Check out the [Manifest V3 Migration Guide](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-migration/).
- Recently added [devtools](https://developer.chrome.com/docs/extensions/mv3/devtools/) Support! Thanks [GeekaholicLin](https://github.com/lxieyang/chrome-extension-boilerplate-react/issues/17)!
- Recently updated from **[Webpack Dev Server](https://webpack.js.org/configuration/dev-server/)** ~~3.x~~ to **4.x** and **[Webpack](https://webpack.js.org/)** ~~4~~ to **5**!
- Recently added [TypeScript](https://www.typescriptlang.org/) Support!

## Features

This is a basic Chrome Extensions boilerplate to help you write modular and modern Javascript code, load CSS easily and [automatic reload the browser on code changes](https://webpack.github.io/docs/webpack-dev-server.html#automatic-refresh).

This boilerplate is updated with:

- [Chrome Extension Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)
- [React 18](https://reactjs.org)
- [Webpack 5](https://webpack.js.org/)
- [Webpack Dev Server 4](https://webpack.js.org/configuration/dev-server/)
- [React Refresh](https://www.npmjs.com/package/react-refresh)
- [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin)
- [eslint-config-react-app](https://www.npmjs.com/package/eslint-config-react-app)
- [Prettier](https://prettier.io/)
- [TypeScript](https://www.typescriptlang.org/)

This boilerplate is heavily inspired by and adapted from [https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate), with additional support for React 18 features, Webpack 5, and Webpack Dev Server 4.

Please open up an issue to nudge me to keep the npm packages up-to-date. FYI, it takes time to make different packages with different versions work together nicely.

## Installing and Running
<p align="center">
<a href="https://onruntime.com">
<img src="src/assets/img/icon-128.png" alt="Kartrak logo" width="64"/>
<h1 align="center">Kartrak</h1>
<h3 align="center">Tracking carbone & activité</h3>
</a>
</p>

<p align="center">
<a aria-label="Google Chrome's users" href="https://chrome.google.com/webstore/detail/kartrak/bheoaeahkgfmogmgkfldoecmnlbhlibf">
<img alt="" src="https://img.shields.io/chrome-web-store/users/bheoaeahkgfmogmgkfldoecmnlbhlibf?label=Users&style=for-the-badge&labelColor=000000&logo=googlechrome&logoColor=white&logoWidth=20">
</a>
<a aria-label="Google Chrome's rating" href="https://chrome.google.com/webstore/detail/kartrak/bheoaeahkgfmogmgkfldoecmnlbhlibf">
<img alt="" src="https://img.shields.io/chrome-web-store/rating-count/bheoaeahkgfmogmgkfldoecmnlbhlibf?label=Rating&style=for-the-badge&labelColor=000000&logo=googlechrome&logoColor=white&logoWidth=20">
</a>
<a aria-label="Google Chrome's version" href="https://chrome.google.com/webstore/detail/kartrak/bheoaeahkgfmogmgkfldoecmnlbhlibf">
<img alt="" src="https://img.shields.io/chrome-web-store/v/bheoaeahkgfmogmgkfldoecmnlbhlibf?label=Version&style=for-the-badge&labelColor=000000&logo=googlechrome&logoColor=white&logoWidth=20">
</a>
</p>

<p align="center">
<a aria-label="Discord" href="https://discord.gg/VvvAkPqQ98">
<img alt="" src="https://img.shields.io/discord/829290979092856833?label=Discord&style=for-the-badge&labelColor=000000&logo=discord&logoColor=white&logoWidth=20">
</a>
<a aria-label="LinkedIn" href="https://linkedin.com/company/tonightpass">
<img alt="" src="https://img.shields.io/badge/LinkedIn-0e76a8.svg?style=for-the-badge&labelColor=000000&logo=linkedin&logoColor=white&logoWidth=20">
</a>
<a aria-label="Instagram" href="https://instagram.com/tonightpass">
<img alt="" src="https://img.shields.io/badge/Instagram-C13584.svg?style=for-the-badge&labelColor=000000&logo=instagram&logoColor=white&logoWidth=20">
</a>
<br />
<a aria-label="onRuntime Studio" href="https://onruntime.com">
<img src="https://img.shields.io/badge/MADE%20BY%20ONRUNTIME-000.svg?style=for-the-badge&labelColor=000" alt="Made by onRuntime Studio">
</a>
<a aria-label="License" href="https://github.com/tonightpass/kitchen/blob/master/LICENSE">
<img alt="" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000">
</a>
</p>

## Community

The TonightPass community can be found on [GitHub Discussions](https://github.com/onruntime/discussions), where you can ask questions, voice ideas, and share your projects.

To chat with other community members join the [onRuntime Studio Discord](https://discord.gg/ucX9c5yXmX).

Our [Code of Conduct](https://docs.onruntime.com/contributing/code-of-conduct) applies to all community channels.

## Contributing

Please see our [contributing rules](https://docs.onruntime.com/contributing/introduction).

### Procedures:

Expand All @@ -53,98 +64,20 @@ Please open up an issue to nudge me to keep the npm packages up-to-date. FYI, it
4. Select the `build` folder.
8. Happy hacking.

## Structure

All your extension's code must be placed in the `src` folder.

The boilerplate is already prepared to have a popup, an options page, a background page, and a new tab page (which replaces the new tab page of your browser). But feel free to customize these.

## TypeScript

This boilerplate now supports TypeScript! The `Options` Page is implemented using TypeScript. Please refer to `src/pages/Options/` for example usages.

## Webpack auto-reload and HRM

To make your workflow much more efficient this boilerplate uses the [webpack server](https://webpack.github.io/docs/webpack-dev-server.html) to development (started with `npm start`) with auto reload feature that reloads the browser automatically every time that you save some file in your editor.

You can run the dev mode on other port if you want. Just specify the env var `port` like this:

```
$ PORT=6002 npm run start
```
## Authors

## Content Scripts
- Antoine Kingue ([@antoinekm](https://github.com/antoinekm))
- Jérémy Baudrin ([@jerembdn](https://github.com/jerembdn))
- Lucas Bodin ([@imazyx](https://github.com/imazyx))

Although this boilerplate uses the webpack dev server, it's also prepared to write all your bundles files on the disk at every code change, so you can point, on your extension manifest, to your bundles that you want to use as [content scripts](https://developer.chrome.com/extensions/content_scripts), but you need to exclude these entry points from hot reloading [(why?)](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/issues/4#issuecomment-261788690). To do so you need to expose which entry points are content scripts on the `webpack.config.js` using the `chromeExtensionBoilerplate -> notHotReload` config. Look the example below.
## License

Let's say that you want use the `myContentScript` entry point as content script, so on your `webpack.config.js` you will configure the entry point and exclude it from hot reloading, like this:
Kartrak is [MIT licensed](LICENSE).

```js
{
…
entry: {
myContentScript: "./src/js/myContentScript.js"
},
chromeExtensionBoilerplate: {
notHotReload: ["myContentScript"]
}
…
}
```
## Made with

and on your `src/manifest.json`:
### Chrome Extension (MV3) Boilerplate with React 18 and Webpack 5

```json
{
"content_scripts": [
{
"matches": ["https://www.google.com/*"],
"js": ["myContentScript.bundle.js"]
}
]
}
```

## Intelligent Code Completion

Thanks to [@hudidit](https://github.com/lxieyang/chrome-extension-boilerplate-react/issues/4)'s kind suggestions, this boilerplate supports chrome-specific intelligent code completion using [@types/chrome](https://www.npmjs.com/package/@types/chrome).

## Packing

After the development of your extension run the command

```
$ NODE_ENV=production npm run build
```

Now, the content of `build` folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the [official guide](https://developer.chrome.com/webstore/publish) to more infos about publishing.

## Secrets

If you are developing an extension that talks with some API you probably are using different keys for testing and production. Is a good practice you not commit your secret keys and expose to anyone that have access to the repository.

To this task this boilerplate import the file `./secrets.<THE-NODE_ENV>.js` on your modules through the module named as `secrets`, so you can do things like this:

_./secrets.development.js_

```js
export default { key: '123' };
```

_./src/popup.js_

```js
import secrets from 'secrets';
ApiCall({ key: secrets.key });
```

:point_right: The files with name `secrets.*.js` already are ignored on the repository.

## Resources:

- [Webpack documentation](https://webpack.js.org/concepts/)
- [Chrome Extension documentation](https://developer.chrome.com/extensions/getstarted)

---

Michael Xieyang Liu | [Website](https://lxieyang.github.io)
[![npm](https://img.shields.io/npm/v/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
[![npm-download](https://img.shields.io/npm/dw/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)
[![npm](https://img.shields.io/npm/dm/chrome-extension-boilerplate-react)](https://www.npmjs.com/package/chrome-extension-boilerplate-react)

0 comments on commit 1e6bb10

Please sign in to comment.