Skip to content

Boilerplate for vue 2&3 plugin development πŸŸ©πŸ“¦

License

Notifications You must be signed in to change notification settings

selimdoyranli/vue-plugin-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

17 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

changelog License

vue-plugin-boilerplate

Boilerplate for vue 2&3 plugin development πŸŸ©πŸ“¦

GitHub stars

Sponsorship πŸ’–
GitHub
Buy me a coffee

Features

  • πŸ“¦ Vue2 & Vue3 support
  • ⚑️ Optimized
  • 🦾 TypeScript support
  • πŸ‘ΆπŸ» Easy
  • πŸ—οΈ Module formats
  • πŸ“ Clean structure

Tech Stack

  • vue-demi for Vue2 & Vue3 support
  • Rollup
  • Pug
  • Scss
  • Typescript
  • Husky
  • Eslint
  • Stylelint
  • Prettier
  • Conventional Commit
  • Commitlint
  • Commitizen
  • Changelogen for release management

Installation

Clone this repo or create new repo from this template repo

git clone https://github.com/selimdoyranli/vue-plugin-boilerplate.git

Development

This project requires node 18.x.x version

Vue3

yarn build:vue3 # build for vue3
# Dev

cd dev/vue3

yarn install
yarn dev

Vue2

yarn build:vue2 # build for vue2
# Dev

cd dev/vue2

yarn install
yarn dev

Vue 2&3

yarn build # build for vue2 and vue3

Linter

# run eslint
yarn lint:eslint

# run eslint fix
yarn lint:eslint:fix

# run stylelint
yarn lint:stylelint

# run stylelint fix
yarn lint:stylelint:fix

# run prettier
yarn prettier

# check types
yarn type:check

Git

Using Conventional Commits, commitizen, commitizen cli

# add files
git add .

# generate commit message
yarn commit # or yarn cz

# push
git push

Release & Changelog

Using changelogen for release & changelog management, arguments are the same as changelogen

# run changelogen
yarn changelog

Sponsorship

You can sponsor me for the continuity of my projects:

License

MIT License

Copyright (c) selimdoyranli [email protected]

About

Boilerplate for vue 2&3 plugin development πŸŸ©πŸ“¦

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published