https://github.com/jose-donato/template-react-browser-extension
an opinionated template for creating browser extensions for chromium and firefox browsers using react tailwind and shadcn-ui
https://github.com/jose-donato/template-react-browser-extension
browser-extension react shadcn-ui tailwindcss
Last synced: 7 months ago
JSON representation
an opinionated template for creating browser extensions for chromium and firefox browsers using react tailwind and shadcn-ui
- Host: GitHub
- URL: https://github.com/jose-donato/template-react-browser-extension
- Owner: jose-donato
- License: mit
- Created: 2024-05-04T17:27:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-02T09:37:37.000Z (about 1 year ago)
- Last Synced: 2025-04-09T23:12:21.255Z (11 months ago)
- Topics: browser-extension, react, shadcn-ui, tailwindcss
- Language: TypeScript
- Homepage:
- Size: 341 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-shadcnui - Github
README
# template-react-browser-extension
an opinionated template for creating browser extensions for chromium and firefox browsers using react tailwind and shadcn-ui
## Development
This project uses [@samrum/vite-plugin-web-extension](https://github.com/samrum/vite-plugin-web-extension). Refer to the plugin documentation for more information.
### Project Setup
```sh
npm install
```
### Commands
Hot Module Reloading is used to load changes inline without requiring extension rebuilds and extension/page reloads
Currently only works in Chromium based browsers.
```sh
npm run dev
```
#### Development, Watch
Rebuilds extension on file changes. Requires a reload of the extension (and page reload if using content scripts)
```sh
npm run watch
```
#### Production
Minifies and optimizes extension build
```sh
npm run build
```
### Load extension in browser
Loads the contents of the dist directory into the specified browser
```sh
npm run serve:chrome
```
```sh
npm run serve:firefox
```
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
- Fork the Project
- Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
- Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
- Push to the Branch (`git push origin feature/AmazingFeature`)
- Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Acknowledgments
- [@samrum/vite-plugin-web-extension](https://github.com/samrum/vite-plugin-web-extension)