Skip to content

web extension boilerplate base on Parcel, supports all technologies you familiar with. Manifest v3 ready!

License

Notifications You must be signed in to change notification settings

oe/web-extension-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Browser extension boilerplate

Base on Parcel, an magic bundler that supports all technologies you familiar with(react/vue/typescript/less/scss, etc), supports the standard Web Extension APIs, for chrome that's Manifest V3.

Features

  1. dev mode, autorefresh when developing, without concern about CSP
  2. build script, auto pack your extension
  3. scss, less, vueI18n(localized your app with vue instead of chrome.i18n.getMessage) integrated
  4. CI github actions integrated, you can download artifact in when workflow done

Building Steps

requirements:

  • make sure you have nodejs v12.10.0 or above installed
  • install yarn. It's optional, you can use npm instead

install deps

run yarn(or npm install) in your shell

dev

  1. run yarn dev(or npm run dev) in your shell
  2. Open the Extension Management page by navigating to chrome://extensions
  3. Enable Developer Mode by clicking the toggle switch next to Developer mode
  4. Click the LOAD UNPACKED button and select the select dist directory

Tips: if you modified src/manifest.json, you may need to reload the extension(by click the refresh icon inside the extension card in chrome://extensions page) to make it take effect immediately.

Above are steps for chrome, if you're a firefox user, you must can figure it out yourself😄

build

run yarn build(or npm run build) in your shell, then you will get a file ext.zip, that's packaged extension

references

About

web extension boilerplate base on Parcel, supports all technologies you familiar with. Manifest v3 ready!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published