copier-browser-ext

A Copier template for scaffolding a browser extension, using Vite and TypeScript.

📦 What is included?

• Vite with Vite Plugin Web Extension.
• TypeScript for type safety.
• PNPM as package manager.
• Eslint and Prettier for code quality and formatting.
• Support for both Chrome and Firefox.
• Documentation with VitePress.
• GitHub Actions workflows for CI and Release automation.
• Release Drafter for automatic release creation and changelog generation.

🚀 Getting Started

Pre-Requisites

This template is built with Copier, a Python based project templating tool.

To install copier on your system, follow the instructions at Copier Website

Usage

To create a new project using this template, run the following command:

copier copy gh:brpaz/copier-browser-ext /path/to/your/new/project

And answer the prompts to customize your new project.

Customize Your Extension

Generate an Icon Set

You can use RealFaviconGenerator to generate a complete set of icons for your extension.

TODO

• Add automated publishing to Chrome and Mozilla stores.

🗒️ License

This project is licensed under the MIT License - see the LICENSE file for details.