Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidnguyen11/web-extension-boilerplate
The web extension boilerplate help to set up project quickly using typescript, jest, webpack, githook, prettier and github actions
https://github.com/davidnguyen11/web-extension-boilerplate
chrome chrome-extension cicd edge firefox firefox-addon firefox-extension githook github-actions githubaction-workflow jest microsoft-edge microsoft-edge-extension prettier typescript webextension webpack
Last synced: 6 days ago
JSON representation
The web extension boilerplate help to set up project quickly using typescript, jest, webpack, githook, prettier and github actions
- Host: GitHub
- URL: https://github.com/davidnguyen11/web-extension-boilerplate
- Owner: davidnguyen11
- License: mit
- Created: 2020-11-19T07:28:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-28T00:09:45.000Z (about 2 years ago)
- Last Synced: 2023-03-04T09:33:36.535Z (over 1 year ago)
- Topics: chrome, chrome-extension, cicd, edge, firefox, firefox-addon, firefox-extension, githook, github-actions, githubaction-workflow, jest, microsoft-edge, microsoft-edge-extension, prettier, typescript, webextension, webpack
- Language: TypeScript
- Homepage:
- Size: 582 KB
- Stars: 72
- Watchers: 1
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Web Extension Boilerplate
This boilerplate provides a skeleton to start developing cross-browser web extensions.
[](#contributors-)
[](https://github.com/facebook/jest) [](https://github.com/prettier/prettier) [](https://github.com/davidnguyen179/web-extension-boilerplate/pulls)
 [](https://github.com/davidnguyen179/web-extension-boilerplate)
## Prerequisites
You need to install [**pnpm**](https://pnpm.io/installation)
## Development
```bash
npm install -g pnpm
```
```bash
pnpm i
```
**Chrome**
```bash
pnpm app:chrome-dev
```
**Edge**
```bash
pnpm app:edge-dev
```
**Firefox**
```bash
pnpm app:firefox-dev
```
## Production
```bash
pnpm i
```
```bash
pnpm app:chrome
```
**Edge**
```bash
pnpm app:edge
```
**Firefox**
```bash
pnpm app:firefox
```
## Load package to browsers
**Chrome**
1. Go to the browser's URL address bar
2. Enter `chrome://extensions/`
3. Switch to "**Developer mode**"
4. Load extension by clicking "**Load unpacked**"
5. Browse to `dist/` in source code
6. Done!
Check here for more detail: [https://developer.chrome.com/extensions/getstarted](https://developer.chrome.com/extensions/getstarted)
**Edge**
1. Go to the browser's URL address bar
2. Enter `edge://extensions/`
3. Turn on `Developer mode`
4. Load extension by clicking "**Load unpacked**"
5. Browse to `dist/` in source code
6. Done!
**Firefox**
1. Go to the browser's URL address bar
2. Enter `about:debugging#/runtime/this-firefox`
3. Click **Load Temporary Add-on...**
4. Browse to your `manifest.json` & click **Open**
5. Done!
Check here for more details: [https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)
## How to keep devtool appears when developing
Simple, just open chrome extension as a page. To do that, follow below steps:
1. Open extension management page
2. Copy extension id
3. Open extension as a page `chrome-extension:///popup.html`
- For example: [chrome-extension://npjcjlkchmiidojhockoecphakigbaej/popup.html](chrome-extension://npjcjlkchmiidojhockoecphakigbaej/popup.html)
## Privacy Policy file
Web stores require you to describe what the extension is or if you collect data of users. You also need to describe why you do that.
Make sure you include this file when you publish an extension, the web store may ask you to upload it.
**Note:** If you don't know how to write a privacy policy file, you can look at the [existing one](https://github.com/davidnguyen179/web-extension-boilerplate/blob/main/PRIVACY_POLICY.txt) attached on this repository.
## Badges
You can add badges to your project to indicate the version or to show how many users use your extension here:
- [https://shields.io/](https://shields.io/)
## CI/CD with github action
You can modify the `.github/workflows` to show the CI/CD flow.
- [https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-nodejs](https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-nodejs)
## How to publish web extension
| Browsers | Web store |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Chrome | [https://developer.chrome.com/webstore/publish](https://developer.chrome.com/webstore/publish) |
| Microsoft Edge | [https://docs.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/publish-extension](https://docs.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/publish-extension) |
| Firefox | [https://extensionworkshop.com/documentation/publish/submitting-an-add-on](https://extensionworkshop.com/documentation/publish/submitting-an-add-on) |
## References
- Develop your first Chrome extension & Chromium Edge: [https://developer.chrome.com/extensions](https://developer.chrome.com/extensions)
- Develop your first Firefox add-on: [https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension)
- If you have any Chrome extension issues, you can post it here: [https://groups.google.com/a/chromium.org/forum/#!forum/chromium-extensions](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-extensions)
- [Jack and Amy Dev youtube channel](https://www.youtube.com/channel/UCVj3dGw75v8aHFYD6CL1tFg), which explains some common mistakes made when developing Chrome extensions.
## Showcase
- [Spotify Web Extension](https://spotify-extension.netlify.app/)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
David Nguyen
💻 📖 🎨 🚧 👀 ⚠️
Minh Ngo
💻 ⚠️
Ben Harned
📖
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!