Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/selimdoyranli/vue-plugin-boilerplate
Boilerplate for vue 2&3 plugin development 🟩📦
https://github.com/selimdoyranli/vue-plugin-boilerplate
vue-boilerplate vue-plugin vue-starter-template
Last synced: about 1 month ago
JSON representation
Boilerplate for vue 2&3 plugin development 🟩📦
- Host: GitHub
- URL: https://github.com/selimdoyranli/vue-plugin-boilerplate
- Owner: selimdoyranli
- License: mit
- Created: 2023-07-23T08:08:18.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2023-08-03T16:46:11.000Z (10 months ago)
- Last Synced: 2024-02-02T05:17:19.743Z (4 months ago)
- Topics: vue-boilerplate, vue-plugin, vue-starter-template
- Language: JavaScript
- Homepage:
- Size: 1.22 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-vue - vue-plugin-boilerplate - Boilerplate for vue 2&3 plugin development 🟩📦 (Resources / Examples)
README
[![changelog][changelog-src]][changelog-href]
[![License][license-src]][license-href]
vue-plugin-boilerplate
Boilerplate for vue 2&3 plugin development 🟩📦
## Features
- 📦 Vue2 & Vue3 support
- ⚡️ Optimized
- 🦾 TypeScript support
- 👶🏻 Easy
- 🏗️ Module formats
- 📁 Clean structure
# Tech Stack
- [vue-demi](https://github.com/vueuse/vue-demi) for Vue2 & Vue3 support
- Rollup
- Pug
- Scss
- Typescript
- Husky
- Eslint
- Stylelint
- Prettier
- Conventional Commit
- Commitlint
- Commitizen
- [Changelogen](https://github.com/unjs/changelogen) for release management
## Installation
Clone this repo or create new repo from this template repo
```bash
git clone https://github.com/selimdoyranli/vue-plugin-boilerplate.git
```
## Development
This project requires node 18.x.x version
### Vue3
```bash
yarn build:vue3 # build for vue3
```
```bash
# Dev
cd dev/vue3
yarn install
yarn dev
```
### Vue2
```bash
yarn build:vue2 # build for vue2
```
```bash
# Dev
cd dev/vue2
yarn install
yarn dev
```
### Vue 2&3
```bash
yarn build # build for vue2 and vue3
```
#### Linter
```bash
# 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](https://www.conventionalcommits.org), commitizen, commitizen cli
```bash
# add files
git add .
# generate commit message
yarn commit # or yarn cz
# push
git push
```
#### Release & Changelog
Using [changelogen](https://github.com/unjs/changelogen) for release & changelog management, arguments are the same as changelogen
```bash
# run changelogen
yarn changelog
```
---
## Sponsorship
You can sponsor me for the continuity of my projects:
## License
[MIT License](./LICENSE)
Copyright (c) selimdoyranli
[changelog-src]: https://img.shields.io/static/v1?label=%F0%9F%93%96&message=Release%20Notes%20|%20CHANGELOG&color=blue
[changelog-href]: ./CHANGELOG.md
[license-src]: https://img.shields.io/badge/License-MIT-blue.svg
[license-href]: ./LICENSE