https://github.com/starter-collective/starter-lib-vue3
Vue 3 component library starter template, provides VitePress documentation, supports building ESM, CJS and UMD formats.
https://github.com/starter-collective/starter-lib-vue3
cjs component esm library starter template typescript ui umd vite vitepress vitest volar vue3
Last synced: 3 months ago
JSON representation
Vue 3 component library starter template, provides VitePress documentation, supports building ESM, CJS and UMD formats.
- Host: GitHub
- URL: https://github.com/starter-collective/starter-lib-vue3
- Owner: starter-collective
- License: mit
- Created: 2024-11-08T03:48:17.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-05-22T02:51:15.000Z (5 months ago)
- Last Synced: 2025-07-10T18:07:50.213Z (3 months ago)
- Topics: cjs, component, esm, library, starter, template, typescript, ui, umd, vite, vitepress, vitest, volar, vue3
- Language: TypeScript
- Homepage: https://starter-lib-vue3.netlify.app
- Size: 418 KB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vue 3 Component Library Starter Template
[](https://github.com/starter-collective/starter-lib-vue3/releases)
[](https://www.npmjs.com/package/starter-lib-vue3)
[](https://github.com/starter-collective/starter-lib-vue3/actions/workflows/ci.yml)
[](https://app.netlify.com/sites/starter-lib-vue3/deploys)
Vue 3 component library starter template, provides VitePress documentation, supports building ESM, CJS and UMD formats.
- [Live Demo](https://starter-lib-vue3.netlify.app/)
- [Play on Stackblitz](https://stackblitz.com/github/starter-collective/starter-lib-vue3)
## Features
- Build package with [Vite](https://vite.dev/guide/build.html#library-mode) - Library mode with no config.
- Out-of-the-box unit testing with [Vitest](https://github.com/vitest-dev/vitest).
- [VitePress](https://vitepress.dev/) documentation - Deploy on [Netlify](https://app.netlify.com/) with zero-config, supports other deployment methods as well.
- Manage versions using the [bumpp](https://github.com/antfu-collective/bumpp), and publish to npm with zero-configPublish to [npm](https://www.npmjs.com) with zero-config.
## Usage
[Create a repo](https://github.com/starter-collective/starter-lib-vue3/generate) from this template on GitHub.
```bash
git clone
```
Install npm dependencies.
```bash
cd starter-lib-vue3 # Or your project directory
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
Just run `dev` script to build your files.
```bash
pnpm dev
```
Open documentation for the library, you can run:
```bash
pnpm docs:dev
```
To build the library, you can run:
```bash
pnpm build
```
If you want to publish it, you can run:
```bash
pnpm release
```
## Clean Template
If you prefer to do it manually with the cleaner git history:
```bash
npx degit starter-collective/starter-lib-vue3 starter-lib-vue3
cd starter-lib-vue3
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
When you use this template, try follow the checklist to update your info properly:
- [ ] Change the package name in `package.json` and the global `umd` variable in `vite.config.ts`.
- [ ] Change the import name in `src/volar.d.ts` for better TypeScript support.
- [ ] Update the website information, favicon, and logo icons in `docs/*`.
## License
[MIT License](./LICENSE) © 2024-PRESENT [Kieran Wang](https://github.com/kieranwv/)