Giter Club home page Giter Club logo

vue-extension-boilerplate's Introduction

๐Ÿš€ Vue Extension Boilerplate

This is a boilerplate for a Chrome Extension using Vite, Vue, and tailwindcss, designed for MV3.

โญ Features

  • Uses Vite as a build tool ๐Ÿ› ๏ธ
  • Utilizes Vue 3 as a front-end framework ๐Ÿ–ฅ๏ธ
  • Includes tailwindcss for easy styling ๐ŸŽจ
  • Supports webextension-polyfill for browser API compatibility ๐ŸŒ
  • Includes hot reload for automatic updates during development ๐Ÿ”ฅ
  • Includes a build script to package the extension ๐Ÿ“ฆ

๐Ÿš€ Getting Started

  1. Clone this repository.
  2. Install dependencies using npm install.
  3. Run the development server using npm run start.
  4. Load the extension in your browser by following these steps:
    • Navigate to chrome://extensions.
    • Turn on Developer mode.
    • Click on "Load unpacked" and select the "dist" folder.
  5. Make changes to the code and see them update automatically in the browser.

๐Ÿ“œ Scripts

  • start: Runs the development server using Vite with hot reload enabled.
  • build: Builds the extension using Vite and outputs the result in the "dist" folder.
  • package: Builds the extension and packages it into a .crx file using the build.js script.
  • test: Runs the vitest command.
  • lint: Lints the code using eslint and the @vue/eslint-config-prettier config.
  • prettier: Formats the code using Prettier.

๐Ÿš€ Future Support

In the future, we plan to add support for Firefox and Safari browsers. Stay tuned for updates!

๐Ÿ“„ License

This project is licensed under the MIT License. See the LICENSE file for details.

vue-extension-boilerplate's People

Contributors

chenten16 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.