Kocal / vue-web-extension

🛠️ A Vue CLI 3+ preset (previously a Vue CLI 2 boilerplate) for quickly starting a web extension with Vue, Babel, ESLint and more!

vue-web-extension

⚠️ This README is for the master version of the preset. If you use the v1 of this boilerplate with Vue-CLI 2 support, please see v1 branch.

---

This Vue CLI preset allows you to quickly start a web extension containing:

• Everything you need to build a web extension (manifest.json, .zip building, ...), thanks to adambullmer/vue-cli-plugin-browser-extension
• Vue 2+
• Vue-router and Vuex
• Axios (configurable)
• Babel with preset-env
• ESLint and Prettier (both configurable)

Requirements

• Node.js >= 10 and npm >= 5
• git
• vue-cli 3+

Documentation

The documentation can be found on vue-web-extension.netlify.app. Please check the documentation website and the open and closed issues, before raising a new issue.

Usage

$ vue create --preset kocal/vue-web-extension my-extension
$ cd my-extension
$ npm run build

npm run build

Build the extension into dist folder for production.

A zip file is also built and is located in artifacts directory.

npm run serve

Build the extension for development and watch over file changes.

It also automatically reload your extension into your browsers, thanks to webpack-extension-reloader plugin.

Options

See https://github.com/adambullmer/vue-cli-plugin-browser-extension#plugin-options