Skip to content

Commit 36a6f96

Browse files
committed
chore: docs
1 parent 2a56936 commit 36a6f96

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

examples/with-react/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Chrome Extension Boilerplate with React + Rsbuild + TypeScript
2+
3+
## Features
4+
5+
- [React 18](https://reactjs.org/)
6+
- [TypeScript](https://www.typescriptlang.org/)
7+
- [Rsbuild](https://rsbuild.dev/)
8+
- [Chrome Extension Manifest Version 3](https://developer.chrome.com/docs/extensions/mv3/intro/)
9+
10+
## Installing and Running
11+
12+
### Procedures:
13+
14+
1. Clone this repository.
15+
2. Change the package's name and description in package.json.
16+
3. Run `pnpm install` to install the dependencies.
17+
18+
## And next, depending on the needs:
19+
20+
### For Chrome:
21+
22+
1. Run:
23+
- Dev: `pnpm dev` or `npm run dev`
24+
- Prod: `pnpm build` or `npm run build`
25+
2. Open in browser - `chrome://extensions`
26+
3. Check - `Developer mode`
27+
4. Click - `Load unpacked extension`
28+
5. Select - `dist` folder
29+
30+
### For Firefox:
31+
32+
1. Run:
33+
- Dev: `pnpm dev:firefox` or `npm run dev:firefox`
34+
- Prod: `pnpm build:firefox` or `npm run build:firefox`
35+
2. Open in browser - `about:debugging#/runtime/this-firefox`
36+
3. Click - `Load Temporary Add-on...`
37+
4. Select - `dist` folder

0 commit comments

Comments
 (0)