Overview:
The vue-web-extensionNetlify is a Vue CLI preset designed to help users quickly start a web extension project. It includes all necessary components such as manifest.json, .zip building, Vue 2+, Vue-router and Vuex, Axios, Babel with preset-env, ESLint, and Prettier. It requires Node.js >= 10, npm >= 5, and vue-cli 3+ for usage.
Features:
- Web Extension Boilerplate: Contains everything needed to build a web extension.
- Vue 2+: Utilizes Vue framework version 2 and above.
- Vue-router and Vuex: Includes routing and state management capabilities.
- Axios Integration: Optional configuration for Axios library.
- Babel with preset-env: Babel setup for environment compatibility.
- ESLint and Prettier: Code linting and formatting tools provided and configurable.
Installation:
To use the Vue CLI preset for web extensions, follow these steps:
- Ensure you have Node.js ≥ 10 and npm ≥ 5 installed.
- Install vue-cli 3+:
npm install -g @vue/cli
- Create a new Vue project:
vue create my-web-extension
- Add the preset to the project:
vue add vue-web-extensionNetlify
- Follow the instructions prompted during the installation.
- Refer to the official documentation for detailed usage: vue-web-extension.netlify.app.
Summary:
The vue-web-extensionNetlify Vue CLI preset offers a convenient way to kickstart web extension projects with essential features like manifest.json, routing, state management, Axios integration, and code quality tools like ESLint and Prettier. With the provided installation guide, users can quickly set up their environment and start building web extensions using Vue.