Browser Extension Starter and Userscript Starter

Features

• One codebase for Chrome extesions, Firefox addons, Userscripts, Bookmarklets and simple JavaScript modules
• Live-reload and React HMR
• Plasmo - The Browser Extension Framework
• esbuild - Bundler
• React
• TypeScript
• Prettier - Code Formatter
• XO - JavaScript/TypeScript linter

Showcases

• 🏷️ UTags - Add usertags to links - Allow users to add custom tags to links.
• 🔗 Links Helper - Open external links in a new tab, open internal links matching the specified rules in a new tab, convert text to hyperlinks, convert image links to image tags, parse Markdown style links and image tags, parse BBCode style links and image tags

How To Make A New Extension

1. Fork this starter repo, and rename repo to your extension name

2. Clone your repo

3. Install dependencies

pnpm install
# or
npm install

Getting Started

First, run the development server:

pnpm dev
# or
npm run dev

Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: build/chrome-mv3-dev.

You can start editing the popup by modifying popup.tsx. It should auto-update as you make changes. To add an options page, simply add a options.tsx file to the root of the project, with a react component default exported. Likewise to add a content page, add a content.ts file to the root of the project, importing some module and do some logic, then reload the extension on your browser.

For further guidance, visit our Documentation

Making production build

Run the following:

pnpm build
# or
npm run build

This should create a production bundle for your extension, ready to be zipped and published to the stores.

Submit to the webstores

The easiest way to deploy your Plasmo extension is to use the built-in bpp GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow this setup instruction and you should be on your way for automated submission!

License

Copyright (c) 2023 Pipecraft. Licensed under the MIT License.

>_