https://github.com/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!
https://github.com/kocal/vue-web-extension

babel eslint prettier vue vue-router vuex web-extension webpack

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/kocal/vue-web-extension
• Owner: Kocal
• License: mit
• Created: 2017-07-21T04:55:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-03T20:09:54.000Z (over 1 year ago)
• Last Synced: 2024-05-02T01:51:16.826Z (6 months ago)
• Topics: babel, eslint, prettier, vue, vue-router, vuex, web-extension, webpack
• Language: JavaScript
• Homepage: https://vue-web-extension.netlify.app/
• Size: 1.18 MB
• Stars: 1,569
• Watchers: 19
• Forks: 166
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Support: docs/support.md

Awesome Lists containing this project

README

        
# vue-web-extension

[![Netlify Status](https://api.netlify.com/api/v1/badges/ae42a82e-1338-4b34-85b8-9100c3d47510/deploy-status)](https://app.netlify.com/sites/vue-web-extension/deploys)

:warning: 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](https://github.com/Kocal/vue-web-extension/tree/v1).

---

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](https://github.com/adambullmer/vue-cli-plugin-browser-extension)

- [Vue 2+](https://github.com/vuejs/vue)

- [Vue-router](https://github.com/vuejs/vue-router) and [Vuex](https://github.com/vuejs/vuex)

- [Axios](https://github.com/axios/axios) (configurable)

- [Babel](https://github.com/babel/babel) with [preset-env](https://github.com/babel/babel/tree/master/packages/babel-preset-env)

- [ESLint](https://github.com/eslint/eslint) and [Prettier](https://github.com/prettier/prettier) (both configurable)

## Requirements

- Node.js >= 10 and npm >= 5

- [git](https://git-scm.com)

- [vue-cli 3+](https://github.com/vuejs/vue-cli)

## Documentation

The documentation can be found on [vue-web-extension.netlify.app](https://vue-web-extension.netlify.app/). Please check the documentation website and the [open and closed issues](https://github.com/Kocal/vue-web-extension/issues?q=), before raising a new issue.

## Usage

```bash

$ 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](https://github.com/rubenspgcavalcante/webpack-extension-reloader) plugin.

## Options

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