# @diamond2221/plus

> Starter template to build component library for vue.js 2-3

Latest version **0.0.1** (published 2022-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @diamond2221/plus
pnpm add @diamond2221/plus
yarn add @diamond2221/plus
bun add @diamond2221/plus
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-09-01 |
| First published | 2022-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 53.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Zhang Yu |
| Maintainers | diamond2221 |
| Keywords | starter, boilerplate, vue, vue3, component, ui, frontend |

## Links

- npm: https://www.npmjs.com/package/@diamond2221/plus
- Repository: https://github.com/diamond2221-com/diamond2221-plus
- Homepage: https://github.com/diamond2221-com/diamond2221-plus#readme
- Issues: https://github.com/diamond2221-com/diamond2221-plus/issues
- npm.io page: https://npm.io/package/@diamond2221/plus

## Dependencies (2)

- [vue-demi](https://npm.io/package/vue-demi.md) ^0.12.1
- [element-plus](https://npm.io/package/element-plus.md) ^2.2.15

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 0.0.1 (latest) — 2022-09-01

## README

## Vivu NPM
[![License](https://img.shields.io/github/license/diamond2221/vivu-npm)](https://github.com/diamond2221-com/diamond2221-plus/blob/master/license.md)
[![Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli)

> Starter template to build component library for vue.js 2-3

## Features
- Faster by default: [vite](https://github.com/vitejs/vite), [vue](https://github.com/vuejs/vue-next), [pnpm](https://github.com/pnpm/pnpm), [esbuild](https://github.com/evanw/esbuild)
- Typescript, of course
- Testing: [vitest](https://vitest.dev/)
- Git custom hooks: [husky](https://github.com/typicode/husky)
- Commit conventions: [commitizen](https://github.com/commitizen/cz-cli)
- Linters: [commitlint](https://github.com/conventional-changelog/commitlint), [eslint](https://github.com/eslint/eslint), [@antfu/eslint-config](https://github.com/antfu/eslint-config)
- CI/CD: [github actions](https://github.com/features/actions)

## Requirement
  - [node.js](http://nodejs.org/)
  - [volta](https://docs.volta.sh/guide/getting-started)
  - [pnpm](https://pnpm.js.org/en/installation)
  - [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)

## Getting Started
### GitHub Template

[Create a repo from this template on GitHub](https://github.com/diamond2221-com/diamond2221-plus/generate).

### Clone to local
If you prefer to do it manually with the cleaner git history

```bash
# clone repository
$ git clone https://github.com/diamond2221-com/diamond2221-plus.git

# open folder vivu-npm
$ cd vivu-npm

# install packages
$ pnpm install

# build and serve with vite dev server
$ pnpm dev
```

## Checklist
When you use this template, try follow the checklist to update your info properly

- [ ] Change `name, description, repository, bugs` field in `package.json`
- [ ] Change the author name in `LICENSE`
- [ ] Change the lib name in `vite.config.ts`
- [ ] Change the favicon in `public`
- [ ] Remove the `.github` folder which contains the funding info
- [ ] Clean up the README(s) and remove modules

And, enjoy :)

## Publish to NPM
Make sure you have added the `GIT_TOKEN` and `NPM_TOKEN` encrypted secrets

```bash
# tag git history
$ git tag v0.0.1 -m 'v0.0.1'

# push tag to git
$ git push origin --tags
```

## Usage
### Setup
Vue 3
```js
import { createApp } from 'vue'
import HelloWorld from '@diamond2221/vivu-npm'
import App from './app.vue'

const app = createApp(App)
app.use(HelloWorld)
```

Vue 2
```js
import Vue from 'vue'
import CompositionAPI from '@vue/composition-api'
import HelloWorld from '@diamond2221/vivu-npm'

Vue.use(CompositionAPI)
Vue.use(HelloWorld)
```

### Basic Usage
```html
<template>
  <hello-world />
</template>
```
[Demo →](https://stackblitz.com/edit/vitejs-vite-e7qhxx?file=src%2FApp.vue)

## Cheer me on
If you like my works, you can cheer me on here 😆

&nbsp; &nbsp; 🇮🇩 [Trakteer](https://trakteer.id/logustra/tip)<br>
&nbsp; &nbsp; 🌍 [Ko-Fi](https://ko-fi.com/logustra)<br>

## License
MIT License © 2022 Faizal Andyka

---
_Source: https://npm.io/package/@diamond2221/plus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._