{"id":13416984,"url":"https://github.com/logustra/vivu-npm","last_synced_at":"2025-07-13T05:32:13.081Z","repository":{"id":42199924,"uuid":"473171630","full_name":"logustra/vivu-npm","owner":"logustra","description":"🧩 Starter template to build component library for vue.js 2-3","archived":false,"fork":false,"pushed_at":"2022-11-21T18:34:07.000Z","size":117,"stargazers_count":45,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-12T12:51:04.771Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@logustra/vivu-npm","language":"TypeScript","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/logustra.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"logustra","ko_fi":"logustra","custom":"https://trakteer.id/logustra/tip"}},"created_at":"2022-03-23T12:09:28.000Z","updated_at":"2024-04-16T01:23:54.000Z","dependencies_parsed_at":"2022-09-15T18:13:09.779Z","dependency_job_id":null,"html_url":"https://github.com/logustra/vivu-npm","commit_stats":null,"previous_names":[],"tags_count":9,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logustra%2Fvivu-npm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logustra%2Fvivu-npm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logustra%2Fvivu-npm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logustra%2Fvivu-npm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/logustra","download_url":"https://codeload.github.com/logustra/vivu-npm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225858346,"owners_count":17535392,"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":[],"created_at":"2024-07-30T22:00:30.785Z","updated_at":"2024-11-22T07:23:55.539Z","avatar_url":"https://github.com/logustra.png","language":"TypeScript","funding_links":["https://github.com/sponsors/logustra","https://ko-fi.com/logustra","https://trakteer.id/logustra/tip"],"categories":["Get Started","TypeScript"],"sub_categories":["Templates"],"readme":"## Vivu NPM\n[![License](https://img.shields.io/github/license/logustra/vivu-npm)](https://github.com/logustra/vivu-npm/blob/master/license.md)\n[![Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n[![Commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli)\n\n\u003e Starter template to build component library for vue.js 2-3\n\n## Features\n- 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)\n- Typescript, of course\n- Testing: [vitest](https://vitest.dev/)\n- Git custom hooks: [husky](https://github.com/typicode/husky)\n- Commit conventions: [commitizen](https://github.com/commitizen/cz-cli)\n- Linters: [commitlint](https://github.com/conventional-changelog/commitlint), [eslint](https://github.com/eslint/eslint), [@antfu/eslint-config](https://github.com/antfu/eslint-config)\n- CI/CD: [github actions](https://github.com/features/actions)\n\n## Requirement\n  - [node.js](http://nodejs.org/)\n  - [volta](https://docs.volta.sh/guide/getting-started)\n  - [pnpm](https://pnpm.js.org/en/installation)\n  - [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)\n\n## Getting Started\n### GitHub Template\n\n[Create a repo from this template on GitHub](https://github.com/logustra/vivu-npm/generate).\n\n### Clone to local\nIf you prefer to do it manually with the cleaner git history\n\n```bash\n# clone repository\n$ git clone https://github.com/logustra/vivu-npm.git\n\n# open folder vivu-npm\n$ cd vivu-npm\n\n# install packages\n$ pnpm install\n\n# build and serve with vite dev server\n$ pnpm dev\n```\n\n## Checklist\nWhen you use this template, try follow the checklist to update your info properly\n\n- [ ] Change `name, description, repository, bugs` field in `package.json`\n- [ ] Change the author name in `LICENSE`\n- [ ] Change the lib name in `vite.config.ts`\n- [ ] Change the favicon in `public`\n- [ ] Remove the `.github` folder which contains the funding info\n- [ ] Clean up the README(s) and remove modules\n\nAnd, enjoy :)\n\n## Publish to NPM\nMake sure you have added the `GIT_TOKEN` and `NPM_TOKEN` encrypted secrets\n\n```bash\n# tag git history\n$ git tag v0.0.1 -m 'v0.0.1'\n\n# push tag to git\n$ git push origin --tags\n```\n\n## Usage\n### Setup\nVue 3\n```js\nimport { createApp } from 'vue'\nimport HelloWorld from '@logustra/vivu-npm'\nimport App from './app.vue'\n\nconst app = createApp(App)\napp.use(HelloWorld)\n```\n\nVue 2\n```js\nimport Vue from 'vue'\nimport CompositionAPI from '@vue/composition-api'\nimport HelloWorld from '@logustra/vivu-npm'\n\nVue.use(CompositionAPI)\nVue.use(HelloWorld)\n```\n\n### Basic Usage\n```html\n\u003ctemplate\u003e\n  \u003chello-world /\u003e\n\u003c/template\u003e\n```\n[Demo →](https://stackblitz.com/edit/vitejs-vite-e7qhxx?file=src%2FApp.vue)\n\n## Cheers me on\nLove my works? give me 🌟 or cheers me on here 😆 \u003cbr\u003e\nYour support means a lot to me. It will help me sustain my projects actively and make more of my ideas come true. \u003cbr\u003e\nMuch appreciated! ❤️ 🙏\n\n\u0026nbsp; \u0026nbsp; 🐙 [Github](https://github.com/sponsors/logustra)\u003cbr\u003e\n\u0026nbsp; \u0026nbsp; 🌍 [Ko-Fi](https://ko-fi.com/logustra)\u003cbr\u003e\n\u0026nbsp; \u0026nbsp; 🇮🇩 [Trakteer](https://trakteer.id/logustra/tip)\u003cbr\u003e\n\n## License\nMIT License © 2022 Faizal Andyka","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogustra%2Fvivu-npm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flogustra%2Fvivu-npm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogustra%2Fvivu-npm/lists"}