https://github.com/julon/vue-cli-template-library

Template for developing open-source vue.js libraries with Rollup + Jest + Babel + Storybook + TravisCI + SemanticRelease
https://github.com/julon/vue-cli-template-library

babel jest linter rollup semantic-release storybook vue vue-cli vue-components vuejs

Last synced: 4 days ago
JSON representation

Template for developing open-source vue.js libraries with Rollup + Jest + Babel + Storybook + TravisCI + SemanticRelease

• Host: GitHub
• URL: https://github.com/julon/vue-cli-template-library
• Owner: julon
• License: mit
• Created: 2018-01-05T20:32:23.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-24T19:49:08.000Z (over 4 years ago)
• Last Synced: 2024-10-04T11:58:34.222Z (about 1 month ago)
• Topics: babel, jest, linter, rollup, semantic-release, storybook, vue, vue-cli, vue-components, vuejs
• Language: JavaScript
• Homepage:
• Size: 3.49 MB
• Stars: 61
• Watchers: 2
• Forks: 12
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# vue-cli-template-library

![Commitizen](https://img.shields.io/badge/Commitizen-enabled-brightgreen.svg)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

![Npm badge](https://img.shields.io/npm/v/vue-cli-template-library.svg)

![Travis badge](https://img.shields.io/travis/julon/vue-cli-template-library.svg)

[![Greenkeeper badge](https://badges.greenkeeper.io/julon/vue-cli-template-library.svg)](https://greenkeeper.io/)

> Template for developing open-source vue.js libraries

> You fell in love with Vue.js and want to create your own unit-tested and documented library to share with everyone but you don't want to spend the whole time set things up? This template is for you! It will take care of managing versioning and publishing to github and npm automatically, so you just need to focus on commiting your pieces of code. Packed with best-practices stuff(linters, preprocessors..) and publishable skeleton.

> Rollup + Jest + Babel + Storybook + TravisCI + SemanticRelease + ❤️

## Usage

```bash

$ npm install -g vue-cli

$ vue init julon/vue-cli-template-library my-project

$ cd my-project

$ npm install

$ npm run storybook

```

## What's included

* `npm run build` : Production-ready build.

  * Export to CommonJS, ES Modules, UMD(dev & minified)

  * CSS is embedded in the JS by default

  * Using Rollup to compute Vue, ES6 js files

  * Pugjs and Stylus supported in vue files

* `npm run storybook` : The UI Development Environment

  * Based on webpack

  * Pre-configured to work out of the box

* `npm run test` : eslint & Unit-test with Jest

  * Supports ES2015+ in test files

  * Use `npm run test:watch` to start Jest in watch-mode

  * Use `npm run test:update` to start Jest and update component snapshot

* `npm run lint`

  * Rules based on prettier:recommended, vue:recommended

  * Import errors and warning detection

  * Use `npm run lint:fix` to fix eslint errors

* `npm run cz` : Commitizen support

  * Loaded with Conventional-changelog rules

  * Entrypoint to semantic-release automation

* Semantic-release auto-deployment configuration

  * Auto-generate changelog

  * Auto-commit computed package version in git

  * Auto-release in github

  * Auto-publish to npm

  * Enable this features by using the semantic-release-cli

## Fork It And Make Your Own

You can fork this repo to create your own boilerplate, and use it with vue-cli:

```bash

vue init username/repo my-project

```