Raptive Evergreen Docs Chrome Extension

Description

TODO

Features

• Chrome Extension Manifest V3
• React 18
• Webpack 5
• Webpack Dev Server 4
• React Refresh
• react-refresh-webpack-plugin
• eslint-config-react-app
• Prettier
• TypeScript

Installing and Running

1. Check if your Node.js version is >= 18.
2. Run yarn to install the dependencies.
3. Run yarn start
4. Load your extension on Chrome following:
   1. Access chrome://extensions/
   2. Check Developer mode
   3. Click on Load unpacked extension
   4. Select the build folder.
5. Happy hacking.

Structure

All extension 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.

Webpack auto-reload and HRM

To make your workflow much more efficient this boilerplate uses the webpack server to development (started with yarn 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 yarn start

Packing

After the development of your extension run the command

$ yarn build:prod

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 for more info 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

export default { key: '123' };

./src/popup.js

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

👉 The files with name secrets.*.js already are ignored on the repository.

Resources:

• Webpack documentation
• Chrome Extension documentation