Skip to content

Commit df096ac

Browse files
committed
Update package.json + README.md
1 parent 1da2789 commit df096ac

File tree

3 files changed

+1364
-1262
lines changed

3 files changed

+1364
-1262
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
[![Tweet](https://img.shields.io/twitter/url/https/github.com/aeksco/react-typescript-web-extension-starter.svg?style=social)](https://twitter.com/intent/tweet?text=https://github.com/aeksco/react-typescript-web-extension-starter)
1313
[![Twitter Follow](https://img.shields.io/twitter/follow/aeksco.svg?style=social)](https://twitter.com/aeksco)
1414

15-
![React TypeScript Web Extension Starter](https://i.imgur.com/DLXldrn.png)
15+
![React TypeScript Web Extension Starter](https://i.imgur.com/wjIiRSv.png)
1616

17-
:desktop_computer: A Web Extension starter kit built with React, TypeScript, SCSS, Storybook, EsLint, Prettier, Jest, Bootstrap,x & Webpack. Compatible with Google Chrome, Mozilla Firefox, and Brave.
17+
:desktop_computer: A Web Extension starter kit built with React, TypeScript, Storybook, EsLint, Prettier, Jest, TailwindCSS, & Webpack. Compatible with Google Chrome, Mozilla Firefox, Brave, and Microsoft Edge.
1818

19-
![Example Extension Popup](https://i.imgur.com/Wp37usG.png "Example Extension Popup")
19+
![Example Extension Popup](https://i.imgur.com/UvOOWlv.png "Example Extension Popup")
2020

2121
**Getting Started**
2222

@@ -41,7 +41,7 @@ yarn dev
4141

4242
In [Google Chrome](https://www.google.com/chrome/), open up [chrome://extensions](chrome://extensions) in a new tab. Make sure the `Developer Mode` checkbox in the upper-right corner is turned on. Click `Load unpacked` and select the `dist` directory in this repository - your extension should now be loaded.
4343

44-
![Installed Extension in Google Chrome](https://i.imgur.com/ORuHbDR.png "Installed Extension in Google Chrome")
44+
![Installed Extension in Google Chrome](https://i.imgur.com/Y2dQFte.png "Installed Extension in Google Chrome")
4545

4646
</details>
4747

@@ -50,37 +50,46 @@ In [Google Chrome](https://www.google.com/chrome/), open up [chrome://extensions
5050

5151
In [Brave](https://brave.com/), open up [brave://extensions](brave://extensions) in a new tab. Make sure the `Developer Mode` checkbox in the upper-right corner is turned on. Click `Load unpacked` and select the `dist` directory in this repository - your extension should now be loaded.
5252

53-
![Installed Extension in Brave](https://i.imgur.com/z8lW02m.png "Installed Extension in Brave")
53+
![Installed Extension in Brave](https://i.imgur.com/rKsbtcO.png "Installed Extension in Brave")
5454

5555
</details>
5656

5757
<details>
5858
<summary>Loading the extension in Mozilla Firefox</summary>
5959

60-
In [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/), open up the [about:debugging](about:debugging) page in a new tab. Click the `Load Temporary Add-on...` button and select the `manfiest.json` from the `dist` directory in this repository - your extension should now be loaded.
60+
In [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/), open up the [about:debugging](about:debugging) page in a new tab. Click the `This Firefox` link in the sidebar. One the `This Firefox` page, click the `Load Temporary Add-on...` button and select the `manfiest.json` from the `dist` directory in this repository - your extension should now be loaded.
6161

62-
![Installed Extension in Mozilla Firefox](https://i.imgur.com/gO2Lrb5.png "Installed Extension in Mozilla Firefox")
62+
![Installed Extension in Mozilla Firefox](https://i.imgur.com/FKfTw4B.png "Installed Extension in Mozilla Firefox")
63+
64+
</details>
65+
66+
<details>
67+
<summary>Loading the extension in Microsoft Edge</summary>
68+
69+
In [Microsoft Edge](https://www.microsoft.com/en-us/edge), open up [edge://extensions](edge://extensions) in a new tab. Make sure the `Developer Mode` checkbox in the lower-left corner is turned on. Click `Load unpacked` and select the `dist` directory in this repository - your extension should now be loaded.
70+
71+
![Installed Extension in Microsoft Edge](https://i.imgur.com/ykesx0g.png "Installed Extension in Microsoft Edge")
6372

6473
</details>
6574

6675
**Notes**
6776

77+
- This project is a [repository template](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/) - click the `Use this template` button to use this starter codebase for your next project.
78+
6879
- Includes ESLint configured to work with TypeScript and Prettier.
6980

7081
- Includes tests with Jest - note that the `babel.config.js` and associated dependencies are only necessary for Jest to work with TypeScript.
7182

7283
- Recommended to use `Visual Studio Code` with the `Format on Save` setting turned on.
7384

74-
- Example icons courtesy of [FontAwesome](https://fontawesome.com).
85+
- Example icons courtesy of [Heroicons](https://heroicons.com/).
7586

76-
- [Microsoft Edge]() is not currently supported.
87+
- [Microsoft Edge](https://www.microsoft.com/en-us/edge) is not currently supported.
7788

7889
- Includes Storybook configured to work with React + TypeScript. Note that it maintains its own `webpack.config.js` and `tsconfig.json` files. See example story in `src/components/hello/__tests__/hello.stories.tsx`
7990

8091
- Includes a custom mock for the [webextension-polyfill-ts](https://github.com/Lusito/webextension-polyfill-ts) package in `src/__mocks__`. This allows you to mock any browser APIs used by your extension so you can develop your components inside Storybook.
8192

82-
![Example Storybook Setup](https://i.imgur.com/ER0WHtY.png "Example Storybook Setup")
83-
8493
**Built with**
8594

8695
- [React](https://reactjs.org)
@@ -91,8 +100,7 @@ In [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/), open up the [a
91100
- [Prettier](https://prettier.io/)
92101
- [Webpack](https://webpack.js.org/)
93102
- [Babel](https://babeljs.io/)
94-
- [Bootstrap](https://getbootstrap.com)
95-
- [SCSS](https://sass-lang.com/)
103+
- [TailwindCSS](https://tailwindcss.com/)
96104
- [webextension-polyfill-ts](https://github.com/Lusito/webextension-polyfill-ts)
97105

98106
**Misc. References**
@@ -103,4 +111,4 @@ In [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/), open up the [a
103111

104112
**Notable forks**
105113

106-
- [capaj](https://github.com/capaj/react-typescript-web-extension-starter) - Chakra-ui instead of Bootstrap+SCSS, Storybook removed
114+
- [capaj](https://github.com/capaj/react-typescript-web-extension-starter) - Chakra-ui instead of TailwindCSS, Storybook removed

package.json

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-typescript-chrome-extension-starter",
3-
"version": "1.0.0",
4-
"description": "A Chrome Extension starter kit built with React, TypeScript, Tailwind CSS, EsLint, Prettier & Webpack",
3+
"version": "2.0.0",
4+
"description": "Web Extension starter kit built with React, TypeScript, Tailwind CSS, EsLint, Prettier & Webpack",
55
"main": "index.js",
66
"scripts": {
77
"build": "webpack --config webpack.prod.js",
@@ -33,23 +33,21 @@
3333
"@babel/core": "^7.11.6",
3434
"@babel/preset-env": "^7.11.5",
3535
"@babel/preset-typescript": "^7.10.4",
36-
"@storybook/addon-actions": "^6.4.9",
37-
"@storybook/addon-console": "^1.2.3",
38-
"@storybook/addon-info": "^5.3.21",
39-
"@storybook/addon-knobs": "^6.0.26",
40-
"@storybook/addon-links": "^6.4.9",
41-
"@storybook/addon-viewport": "^6.4.9",
42-
"@storybook/addons": "^6.4.9",
43-
"@storybook/preset-typescript": "^3.0.0",
36+
"@storybook/addon-essentials": "^6.4.9",
37+
"@storybook/addon-interactions": "^6.4.9",
38+
"@storybook/builder-webpack5": "^6.4.9",
39+
"@storybook/manager-webpack5": "^6.4.9",
4440
"@storybook/react": "^6.4.9",
41+
"@storybook/testing-library": "^0.0.7",
4542
"@types/chrome": "^0.0.124",
4643
"@types/jest": "^26.0.14",
4744
"@types/node": "^14.11.8",
48-
"@types/react": "^16.9.52",
49-
"@types/react-dom": "^16.9.8",
50-
"@types/react-test-renderer": "^16.9.3",
45+
"@types/react": "^17.0.2",
46+
"@types/react-dom": "^17.0.2",
47+
"@types/react-test-renderer": "^17.0.1",
5148
"@typescript-eslint/eslint-plugin": "^4.4.1",
5249
"@typescript-eslint/parser": "^4.4.1",
50+
"autoprefixer": "^10.4.1",
5351
"awesome-typescript-loader": "^5.2.1",
5452
"babel-core": "^6.26.3",
5553
"babel-jest": "^26.5.2",
@@ -61,22 +59,21 @@
6159
"eslint-plugin-react": "^7.21.4",
6260
"jest": "^26.5.3",
6361
"jest-css-modules": "^2.1.0",
62+
"postcss": "^8.4.5",
63+
"postcss-loader": "^6.2.1",
6464
"prettier": "^2.1.2",
65-
"react-docgen-typescript-loader": "^3.7.2",
66-
"react-docgen-typescript-webpack-plugin": "^1.1.0",
67-
"storybook-addon-jsx": "^7.3.14",
68-
"style-loader": "^2.0.0",
65+
"react-test-renderer": "^17.0.2",
66+
"tailwindcss": "^3.0.8",
6967
"ts-jest": "^26.4.1",
7068
"ts-loader": "^8.0.5",
7169
"typescript": "^4.0.3",
7270
"webextension-polyfill-ts": "^0.20.0",
73-
"webpack": "^4.41.5",
74-
"webpack-cli": "^3.3.10",
75-
"webpack-merge": "^4.2.2"
71+
"webpack": "^5.65.0",
72+
"webpack-cli": "^4.9.1",
73+
"webpack-merge": "^5.8.0"
7674
},
7775
"dependencies": {
78-
"react": "^16.13.1",
79-
"react-dom": "^16.13.1",
80-
"react-test-renderer": "^16.13.1"
76+
"react": "^17.0.2",
77+
"react-dom": "^17.0.2"
8178
}
8279
}

0 commit comments

Comments
 (0)