https://github.com/BCIT-DDC/web-extension-ts-starter
🚀 A web extension starter built with React, Typescript, and Tailwind CSS. Build once, and run on multiple browsers: Google Chrome, Mozilla Firefox, Microsoft Edge, Brave, and Opera.
https://github.com/BCIT-DDC/web-extension-ts-starter
brave-extension chrome-extension extension firefox-extension hackathon jest react starter tailwindcss template typescript webpack5
Last synced: about 1 month ago
JSON representation
🚀 A web extension starter built with React, Typescript, and Tailwind CSS. Build once, and run on multiple browsers: Google Chrome, Mozilla Firefox, Microsoft Edge, Brave, and Opera.
- Host: GitHub
- URL: https://github.com/BCIT-DDC/web-extension-ts-starter
- Owner: BCIT-DDC
- License: mit
- Created: 2022-01-04T07:33:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-12T05:39:55.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T09:36:02.109Z (6 months ago)
- Topics: brave-extension, chrome-extension, extension, firefox-extension, hackathon, jest, react, starter, tailwindcss, template, typescript, webpack5
- Language: JavaScript
- Homepage:
- Size: 893 KB
- Stars: 39
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
## Web Extension Starter
A web extension starter, built with React, Typescript, and Tailwind CSS. Build once, and run on multiple browsers: Google Chrome, Mozilla Firefox, Microsoft Edge, and Brave.
### Built With
- 
- 
- 
- 
## Getting Started
### 1. Download starter and install dependencies
Clone this repository:
```
git clone [email protected]:BCIT-DDC/web-extension-ts-starter.git
```
Install npm dependencies:
```
cd web-extension-ts-starter
npm install
```
### 2. Build the Extension
#### Start the Webpack Development Server
```
npm run dev
```
#### Build the Production-Ready Extension
```
npm run build
```
The relevant web extension files will be present in the output `.dist/` folder.
## Usage
--
## Roadmap
- [ ] Add support for Opera
See the [open issues](https://github.com/BCIT-DDC/web-extension-ts-starter/issues) for a full list of proposed features (and known issues).
## 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**.
If you would like to contribute, please have a look at our [contributing guidelines](https://github.com/BCIT-DDC/docs/blob/main/contributing.md).
### Contributors
This project exists thanks to all the people who contribute.
## License
[MIT](LICENSE.md) © BCIT-DDC
## Acknowledgments
- [Heroicons](https://heroicons.com/)
- [Headless UI](https://headlessui.dev/)
## Status
