Skip to content

Commit e5a4a2a

Browse files
First commit
0 parents  commit e5a4a2a

File tree

2 files changed

+188
-0
lines changed

2 files changed

+188
-0
lines changed

README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!-- <p align="center">
2+
<img alt="Vuetify Logo" width="100" src="https://raw.githubusercontent.com/webdevnerdstuff/vuetify-plugin-template/main/src/assets/vuetify-logo.svg">
3+
</p> -->
4+
5+
<p>
6+
<h1 align="center">Vuetify Plugin Template</h1>
7+
</p>
8+
9+
<p align="center">
10+
<!-- <a href="https://www.npmjs.com/package/vuetify-plugin-template">
11+
<img src="https://img.shields.io/npm/v/vuetify-plugin-template?color=1867c0&logo=npm" alt="NPM Package">
12+
</a>
13+
&nbsp; -->
14+
<a href="https://github.com/webdevnerdstuff/vuetify-plugin-template">
15+
<img src="https://img.shields.io/badge/GitHub-WebDevNerdStuff-brightgreen.svg?logo=github" alt="@WebDevNerdStuff">
16+
</a>
17+
</p>
18+
19+
20+
## Description
21+
22+
Vuetify Plugin Template is a template to help you get starting building your own plugin/component for Vuetify.
23+
24+
25+
## Development Playground
26+
27+
The `vuetify-plugin-template` is still in beta. If you would like to test the component library out, you can clone the repo and run the following commands:
28+
29+
`pnpm i && pnpm play`
30+
31+
This will open up a Playground page that loads the file `./src/playground/PlaygroundPage.vue`. You can edit this file to test out the component.
32+
33+
34+
## Installation
35+
36+
Using [pnpm](https://pnpm.io/):
37+
```
38+
pnpm add vuetify-plugin-template
39+
```
40+
41+
Using npm:
42+
```
43+
npm i vuetify-plugin-template
44+
```
45+
46+
## Documentation
47+
48+
[Documentation & Demo](https://webdevnerdstuff.github.io/vuetify-plugin-template/)
49+
50+
## Dependencies
51+
52+
[Vuetify v3](https://vuetifyjs.com/)
53+
[Vue 3](https://vuejs.org/)
54+
[VueUse](https://vueuse.org/)
55+
56+
57+
## Change Log
58+
59+
[CHANGELOG](https://github.com/webdevnerdstuff/vuetify-plugin-template/blob/master/CHANGELOG.md)
60+
61+
62+
## License
63+
64+
Copyright (c) 2023 WebDevNerdStuff
65+
Licensed under the [MIT license](https://github.com/webdevnerdstuff/vuetify-plugin-template/blob/master/LICENSE.md).
66+
67+
68+
## Legal
69+
70+
Vuetify and the Vuetify logo are trademarks of Vuetify. This component was not created or endorsed by Vuetify.

package.json

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
{
2+
"name": "vuetify-plugin-template",
3+
"version": "1.0.0",
4+
"description": "Vuetify Plugin Template",
5+
"private": false,
6+
"main": "dist/vuetify-plugin-template.cjs.js",
7+
"module": "dist/vuetify-plugin-template.es.js",
8+
"types": "dist/types/index.d.ts",
9+
"scripts": {
10+
"dev": "vite",
11+
"watch": "pnpm dev",
12+
"play": "sh src/playground/configs/build.sh && NODE_ENV=playground vite",
13+
"build": "vue-tsc && vite build --config vite.build.config.ts",
14+
"build:docs": "vite build",
15+
"predeploy": "npm run build",
16+
"deploy": "gh-pages -d docs",
17+
"prepublishOnly": "npm run build",
18+
"lint": "eslint src/**/*.{ts,vue} --max-warnings 20",
19+
"prepare": "husky install"
20+
},
21+
"lint-staged": {
22+
"src/**/*.{js,ts,vue}": [
23+
"npm run lint"
24+
]
25+
},
26+
"author": "WebDevNerdStuff & Bunnies... lots and lots of bunnies! <[email protected]> (https://webdevnerdstuff.com)",
27+
"funding": [],
28+
"license": "MIT",
29+
"files": [
30+
"dist/*",
31+
"LICENSE.md",
32+
"README.md"
33+
],
34+
"repository": "https://github.com/webdevnerdstuff/vuetify-plugin-template",
35+
"bugs": {
36+
"url": "https://github.com/webdevnerdstuff/vuetify-plugin-template/issues"
37+
},
38+
"homepage": "https://webdevnerdstuff.github.io/vuetify-plugin-template/",
39+
"keywords": [
40+
"vuetify-plugin-template",
41+
"vuetify",
42+
"vue",
43+
"vue3",
44+
"component",
45+
"plugin",
46+
"javascript",
47+
"typescript",
48+
"webdevnerdstuff",
49+
"wdns"
50+
],
51+
"dependencies": {
52+
"@vueuse/core": "^10.2.1",
53+
"vue": "^3.3.4",
54+
"vuetify": "^3.3.9"
55+
},
56+
"devDependencies": {
57+
"@babel/core": "^7.22.9",
58+
"@babel/eslint-parser": "^7.22.9",
59+
"@fortawesome/fontawesome-svg-core": "^6.4.0",
60+
"@fortawesome/free-brands-svg-icons": "^6.4.0",
61+
"@fortawesome/free-regular-svg-icons": "^6.4.0",
62+
"@fortawesome/free-solid-svg-icons": "^6.4.0",
63+
"@fortawesome/vue-fontawesome": "^3.0.3",
64+
"@mdi/font": "^7.2.96",
65+
"@rollup/plugin-commonjs": "^25.0.3",
66+
"@rollup/plugin-node-resolve": "^15.1.0",
67+
"@rollup/plugin-terser": "^0.4.3",
68+
"@types/node": "^20.4.2",
69+
"@typescript-eslint/eslint-plugin": "^6.1.0",
70+
"@typescript-eslint/parser": "^6.1.0",
71+
"@vitejs/plugin-vue": "^4.2.3",
72+
"@vue/cli-plugin-babel": "^5.0.8",
73+
"@vue/cli-plugin-eslint": "^5.0.8",
74+
"@vue/cli-service": "^5.0.8",
75+
"@vue/compiler-sfc": "^3.3.4",
76+
"@vue/eslint-config-typescript": "^11.0.3",
77+
"autoprefixer": "^10.4.14",
78+
"eslint": "^8.45.0",
79+
"eslint-config-prettier": "^8.8.0",
80+
"eslint-plugin-import": "^2.27.5",
81+
"eslint-plugin-prettier": "^5.0.0",
82+
"eslint-plugin-vue": "^9.15.1",
83+
"gh-pages": "^5.0.0",
84+
"husky": "^8.0.3",
85+
"lint-staged": "^13.2.3",
86+
"miragejs": "^0.1.47",
87+
"pinia": "^2.1.4",
88+
"postcss": "^8.4.26",
89+
"postcss-html": "^1.5.0",
90+
"postcss-scss": "^4.0.6",
91+
"prettier": "^3.0.0",
92+
"prismjs": "^1.29.0",
93+
"roboto-fontface": "^0.10.0",
94+
"rollup": "^3.26.3",
95+
"rollup-plugin-polyfill-node": "^0.12.0",
96+
"rollup-plugin-postcss": "^4.0.2",
97+
"rollup-plugin-scss": "^4.0.0",
98+
"rollup-plugin-typescript2": "^0.35.0",
99+
"sass": "^1.64.0",
100+
"stylelint": "^15.10.2",
101+
"stylelint-config-standard": "^34.0.0",
102+
"stylelint-order": "^6.0.3",
103+
"stylelint-scss": "^5.0.1",
104+
"typescript": "^5.1.6",
105+
"unplugin-auto-import": "^0.16.6",
106+
"vite": "^4.4.5",
107+
"vite-plugin-babel": "^1.1.3",
108+
"vite-plugin-css-injected-by-js": "^3.2.1",
109+
"vite-plugin-dts": "^3.3.1",
110+
"vite-plugin-eslint": "^1.8.1",
111+
"vite-plugin-static-copy": "^0.17.0",
112+
"vite-plugin-stylelint": "^4.3.0",
113+
"vite-plugin-vuetify": "^1.0.2",
114+
"vue-tsc": "^1.8.5",
115+
"vue3-code-block": "^2.2.12",
116+
"webfontloader": "^1.6.28"
117+
}
118+
}

0 commit comments

Comments
 (0)