Holllo

An opinionated WebExtension template.

free-and-open-source html license-the-unlicense scss typescript webextension

Go to file

Bauke c797d4640b Rename the license file.		2022-09-28 22:31:14 +02:00
source	Add Chromium/Manifest V3 compatibility.	2022-03-23 21:52:22 +01:00
.gitignore	Initial commit! 🎉	2022-03-02 13:17:15 +01:00
.stylelintrc.json	Initial commit! 🎉	2022-03-02 13:17:15 +01:00
LICENSE	Rename the license file.	2022-09-28 22:31:14 +02:00
README.md	Initial commit! 🎉	2022-03-02 13:17:15 +01:00
package.json	Update dependencies, disable false-positive XO rules.	2022-09-07 17:48:46 +02:00
pnpm-lock.yaml	Update dependencies, disable false-positive XO rules.	2022-09-07 17:48:46 +02:00
tsconfig.json	Initial commit! 🎉	2022-03-02 13:17:15 +01:00
vite.config.ts	Add Chromium/Manifest V3 compatibility.	2022-03-23 21:52:22 +01:00

README.md

WebExtension Template

An opinionated WebExtension template.

Building with Vite and vite-plugin-web-extension
Packaging with git-archive, pnpm and web-ext
Sass and TypeScript preconfigured
Stylelint and XO code linting
HTM and Preact frontend development
Typed browser APIs with webextension-polyfill

Usage

Download the repository.
Install the dependencies.
- Optionally update the dependencies too.
Start an auto-reloading browser instance for development.
Check for linting and TypeScript errors.
Build the WebExtension for production.

# Step 1.
pnpx degit Holllo/web-ext-template your-awesome-project
cd your-awesome-project

# Step 2.
pnpm install
pnpm update --latest

# Step 3, you can change which browser to use in the Vite config.
pnpm start

# Step 4.
pnpm test

# Step 5, see the web-ext-artifacts directory for output.
pnpm build