https://github.com/biigpongsatorn/vue-lib-template
๐ A simple template for building and publishing Vue component/library as a opensource.
https://github.com/biigpongsatorn/vue-lib-template
boilerplate building cli component generate generator lib library npm npm-module npm-package opensource publishing simple template vue webpack
Last synced: 7 months ago
JSON representation
๐ A simple template for building and publishing Vue component/library as a opensource.
- Host: GitHub
- URL: https://github.com/biigpongsatorn/vue-lib-template
- Owner: biigpongsatorn
- License: mit
- Created: 2018-05-21T04:10:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-17T03:33:43.000Z (over 7 years ago)
- Last Synced: 2025-04-30T03:39:18.109Z (7 months ago)
- Topics: boilerplate, building, cli, component, generate, generator, lib, library, npm, npm-module, npm-package, opensource, publishing, simple, template, vue, webpack
- Language: JavaScript
- Homepage:
- Size: 31.3 KB
- Stars: 18
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vue - vue-lib-template - A simple template for building and publishing Vue component/library as a opensource. (Scaffold [๐](#readme))
- awesome-vue-zh - VIEๅบๆจกๆฟ - ไธไธช็ฎๅ็ๆจกๆฟ,็จไบๆๅปบๅๅๅธVue็ปไปถ/ๅบไฝไธบๅผๆบ. (่ๆๆถ / ๆบไปฃ็ ็ผ่พ)
- awesome-vue - vue-lib-template - ๐ A simple template for building and publishing Vue component/library as an open source project. (Components & Libraries / Scaffold)
- awesome-vue - vue-lib-template โ 9 - ๐ A simple template for building and publishing Vue component/library as a opensource. (Scaffold / Source Code Editing)
- awesome-vue - vue-lib-template - ๐ A simple template for building and publishing Vue component/library as a opensource. (Scaffold / Source Code Editing)
README
# vue-lib-template
๐ A simple template for building and publishing Vue component/library as a opensource, Base on [webpack-simple](https://github.com/vuejs-templates/webpack-simple) & [bili](https://github.com/egoist/bili)
# ๐ก Feature
- Light weight template.
- Zero config bundler.
- Included build with minification.
- Quick prototyping.
- This template is Vue 2.0 compatible.
- Included demo page.
# ๐ป Usage
- Install [vue-cli](https://github.com/vuejs/vue-cli)
``` bash
$ npm install -g vue-cli
```
- Initial component/library
``` bash
$ vue init biigpongsatorn/vue-lib-template my-project
$ cd my-project
$ npm install
$ npm run dev
```
# ๐ Directory Structure
```
my-project
โ
โโโ example
โ โโโ App.vue
โ โโโ main.js
โโโ src
โ โโโ index.vue
โโโ .babelrc
โโโ .editorconfig
โโโ .gitignore
โโโ .npmignore
โโโ bili.config.js
โโโ index.html
โโโ package.json
โโโ README.md
โโโ webpack.config.js
```
# ๐ Building
- Building demo page.
``` bash
$ npm run build:example
```
- Building component/library.
``` bash
$ npm run build:lib
```
- Publishing to npm. (Please run `npm run build:lib` and `npm version patch` before publish to NPM)
``` bash
$ npm publish
```
# ๐๐ป Support
```
If you like this project, You can support me with starring โญ this repository.
```
# ๐ License
[MIT](LICENSE)
Developed with โค๏ธ and โ๏ธ