{"id":16365195,"url":"https://github.com/xiaoluoboding/vue-library-starter","last_synced_at":"2025-10-11T00:03:21.118Z","repository":{"id":190065962,"uuid":"681923831","full_name":"xiaoluoboding/vue-library-starter","owner":"xiaoluoboding","description":"My minimal Vue library starter, built on top of Vite \u0026 Vue 3","archived":false,"fork":false,"pushed_at":"2024-04-06T08:23:42.000Z","size":50,"stargazers_count":8,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-31T07:36:40.586Z","etag":null,"topics":["library","nuxt3","starter-template","vue3"],"latest_commit_sha":null,"homepage":"https://vue-library-starter.vercel.app","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xiaoluoboding.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":["xiaoluoboding"]}},"created_at":"2023-08-23T04:02:25.000Z","updated_at":"2024-08-09T03:10:45.000Z","dependencies_parsed_at":"2024-04-06T09:26:12.503Z","dependency_job_id":"e564d261-7bc6-4f9d-b94f-f6f1201326f1","html_url":"https://github.com/xiaoluoboding/vue-library-starter","commit_stats":null,"previous_names":["xiaoluoboding/vue-library-starter"],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiaoluoboding%2Fvue-library-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiaoluoboding%2Fvue-library-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiaoluoboding%2Fvue-library-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiaoluoboding%2Fvue-library-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xiaoluoboding","download_url":"https://codeload.github.com/xiaoluoboding/vue-library-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239809552,"owners_count":19700641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","nuxt3","starter-template","vue3"],"created_at":"2024-10-11T02:42:54.348Z","updated_at":"2025-10-11T00:03:21.112Z","avatar_url":"https://github.com/xiaoluoboding.png","language":"Vue","readme":"# Vue Library Starter\n\n[![NPM][npmBadge]][npmUrl]\n[![Minzip Package][bundlePhobiaBadge]][bundlePhobiaUrl]\n[![NPM Download][npmDtBadge]][npmDtUrl]\n\n[npmBadge]: https://img.shields.io/npm/v/vue-library-starter.svg?maxAge=2592000\n[npmUrl]: https://www.npmjs.com/package/vue-library-starter\n[npmDtBadge]: https://img.shields.io/npm/dt/vue-library-starter.svg\n[npmDtUrl]: https://www.npmjs.com/package/vue-library-starter\n[bundlePhobiaBadge]: https://img.shields.io/bundlephobia/minzip/vue-library-starter\n[bundlePhobiaUrl]: https://bundlephobia.com/package/vue-library-starter@latest\n\n\u003e A minimal Vue library starter, built on top of Vite \u0026 Vue 3\n\n## Table of Contents\n\n\u003cdetails\u003e\n\n\u003csummary\u003eTOC\u003c/summary\u003e\n\n- [Vue Library Starter](#vue-library-starter)\n  - [Table of Contents](#table-of-contents)\n  - [Features](#features)\n  - [Use the Template](#use-the-template)\n    - [GitHub Template](#github-template)\n    - [Clone to local](#clone-to-local)\n  - [Usage](#usage)\n    - [1、Install dependencies](#1install-dependencies)\n    - [2、Build a library](#2build-a-library)\n    - [3、Build nuxt library](#3build-nuxt-library)\n    - [4、Publish to npm](#4publish-to-npm)\n  - [License](#license)\n\n\u003c/details\u003e\n\n## Features\n\n- Package manager [pnpm](https://pnpm.js.org/), safe and fast\n- Bundle with the [library mode](https://vitejs.dev/guide/build.html#library-mode)\n- Release with [semantic-release](https://www.npmjs.com/package/semantic-release)\n- Publish to [npm](https://docs.npmjs.com/cli/v8/commands/npm-publish)\n\n## Use the Template\n\n### GitHub Template\n\n[create a repo from this template on GitHub](https://github.com/new?template_name=vue-library-starter\u0026template_owner=xiaoluoboding)\n\n### Clone to local\n\n```bash\ngit clone https://github.com/xiaoluoboding/vue-library-starter\n\ncd vue-library-starter\n```\n\n## Usage\n\nBuilding it is as easy as 1, 2, 3.\n\n### 1、Install dependencies\n\n```bash\npnpm install\n```\n\n### 2、Build a library\n\nRename all the `vue-library-starter` to your component name in the file `package.json、vite.config.ts`, eg: `my-component`\n\n```bash\npnpm run build:lib\n```\n\n### 3、Build nuxt library\n\nThis repository ships a Nuxt module so you can use the library in Nuxt projects.\n\n- Prepare the Nuxt playground and stub the module (handy for local testing)\n\n```bash\npnpm run dev:nuxt:prepare\n```\n\n- Run the Nuxt playground to verify everything works\n\n```bash\npnpm run dev:nuxt\n```\n\n- Build the Nuxt module artifacts to `lib/nuxt`\n\n```bash\npnpm run build:module\n```\n\n- (Optional) Build all outputs (ESM, UMD, Nuxt) in one go\n\n```bash\npnpm run release\n```\n\nUse in a Nuxt app by adding the module and CSS in your `nuxt.config.ts`:\n\n```ts\nexport default defineNuxtConfig({\n  modules: ['vue-library-starter/nuxt'],\n  css: ['vue-library-starter/style.css']\n})\n```\n\n### 4、Publish to npm\n\n```bash\nnpm publish\n```\n\n## License\n\nMIT [@xiaoluoboding](https://github.com/xiaoluoboding)\n","funding_links":["https://github.com/sponsors/xiaoluoboding"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxiaoluoboding%2Fvue-library-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxiaoluoboding%2Fvue-library-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxiaoluoboding%2Fvue-library-starter/lists"}