{"id":13429303,"url":"https://github.com/ow3org/vue-starter","last_synced_at":"2025-03-16T03:31:17.403Z","repository":{"id":37022820,"uuid":"498586947","full_name":"ow3org/vue-starter","owner":"ow3org","description":"🏖 Vue Component Library Starter kit to help kick-start development of your next library.","archived":false,"fork":false,"pushed_at":"2024-10-23T08:08:03.000Z","size":989,"stargazers_count":4,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-24T17:51:38.463Z","etag":null,"topics":["component","library","package","template","typescript","vue"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ow3org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-01T04:13:09.000Z","updated_at":"2024-02-05T14:22:15.000Z","dependencies_parsed_at":"2023-10-14T22:16:03.567Z","dependency_job_id":"3d7192e8-3fc4-4acb-a935-69d423574e75","html_url":"https://github.com/ow3org/vue-starter","commit_stats":null,"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow3org%2Fvue-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow3org%2Fvue-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow3org%2Fvue-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ow3org%2Fvue-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ow3org","download_url":"https://codeload.github.com/ow3org/vue-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243822312,"owners_count":20353496,"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":["component","library","package","template","typescript","vue"],"created_at":"2024-07-31T02:00:33.850Z","updated_at":"2025-03-16T03:31:16.971Z","avatar_url":"https://github.com/ow3org.png","language":"JavaScript","funding_links":[],"categories":["Projects Using Stacks"],"sub_categories":["Scaffold"],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\".github/art/social.png\" alt=\"Social Card of Vue Starter\"\u003e\u003c/p\u003e\n\n[![npm version][npm-version-src]][npm-version-href]\n[![GitHub Actions][github-actions-src]][github-actions-href]\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n\u003c!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] --\u003e\n\u003c!-- [![Codecov][codecov-src]][codecov-href] --\u003e\n\n# Vue Component Library Starter\n\nVue Starter helps kick-start \u0026 maintain development of your next Vue component library. It is the most simple \u0026 comfortable solution for Vue developers to build highly-modular, widely-accepted \u0026 scalable component libraries. No matter whether you are a beginner or an expert, Stacks' approachable design allows you to learn more about its capabilities as you develop your library.\n\n\u003e _The clever way to build component libraries._\n\nDevelop beautiful reactive composable UIs without learning a new language. HTML, CSS, sprinkled with minimal JavaScript—dive in now!\n\n## ☘️ Features\n\nThe ultimate goal of this Starter Kit is to _help you_ create a component library. It is a ah optimized build process that automatically generates `.mjs` \u0026 `.cjs` library distributions for you, including its types. Other core features include:\n\n- Automagically builds \u0026 distributes Vue 2 \u0026 3 libraries for you\n- Zero-config by default, yet highly-configurable—if needed\n- Delightful Developer Experience _(DX)_\n- Style with ease via UnoCSS _(e.g. Tailwind CSS, Windi CSS, Heroicons, Bootstrap, etc.)_\n- Modern git commit conventions\n- Automated npm package releases \u0026 semver versioning\n- Pretty changelog generations _(markdown \u0026 GitHub releases)_\n- Fully-typed, automatically _(your components \u0026 composables)_\n- Optimized \u0026 automated GitHub PR dependency updates\n- Bootstrapped documentation tooling \u0026 site to present library _(via VitePress)_\n\n## 💡 Get Started\n\nIt's incredibly easy to get started. The only prerequisite is a basic understanding HTML \u0026 JavaScript. In other words, there is virtually no learning curve because \"HTML with sprinkled JavaScript\" will get you _incredibly_ far.\n\n```bash\n# you may \"Use this template\" via the button in top right corner of this page\n# or run the following commands:\nnpx degit openwebstacks/vue-starter hello-world-stack\ncd hello-world-stack\nnpm run setup # WIP\n```\n\nTo learn more, read more here\n\n## 🤖 Usage\n\nThe following is a list of the most common ways to use interact with Stacks\n\n```bash\npnpm install # install all dependencies (for all packages/workspaces)\npnpm fresh # fresh reinstall of all dependencies\n\npnpm dev # stubs the libraries for local use\npnpm build # builds the library for production-ready use\npnpm example # run one of the examples (follow CLI prompts)\n\npnpm commit # follow CLI prompts for committing changes\npnpm release # releases the library (packages) to npm\n\npnpm docs:dev # starts local server for the documentation site\npnpm docs:build # builds the documentation site\npnpm docs:serve # serves the documentation site\n```\n\n_The `package.json` may contain additional useful snippets you want to be aware of._\n\nBecause we optimize toward the development of easily reusable \u0026 composable component libraries, our primary intention is always _keep it simple, yet configurable_:\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport HelloWorld from '@ow3/hello-world-vue'\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cHelloWorld name=\"J Doe\" /\u003e\n\u003c/template\u003e\n```\n\nRead more about the setup \u0026 tips in the docs.\n\n### Developer Experience (DX)\n\nThis Starter Kit is a Component-First, UI \u0026 Build Framework. When developing your own library, this Starter Kit bootstraps the following for you:\n\n- [Powerful Build Engine](https://github.com/openwebstacks/vue-starter/tree/main/.stacks/builds) - Stacks is a optimized [Vite](https://vitejs.dev/) build engine\n- [Modern CSS Engine](https://github.com/unocss/unocss) - pre-configured UnoCSS allows to create \u0026 manage your style guide with ease\n- [Fully Typed APIs](https://www.typescriptlang.org/) - via TypeScript 4.8\n- [Be a Good Commitizen](https://www.npmjs.com/package/git-cz) - pre-configured Commitizen \u0026 git-cz setup to simplify semantic git commits, versioning, and changelog generations\n- [Built With Testing In Mind](https://github.com/vitest-dev/vitest) - pre-configured unit \u0026 e2e-testing powered by [Vitest](https://github.com/vitest-dev/vitest)\n- [Renovate](https://renovatebot.com/) - optimized \u0026 automated PR dependency updates\n- [GitHub Actions](https://github.com/features/actions) - runs your CI (fixes code style issues, tags releases \u0026 creates its changelogs, runs the test suite, etc.\n\n#### Plugins \u0026 Extensions\n\n- [Automagically imports components](https://github.com/antfu/unplugin-vue-components)\n- [Use framework functionalities without imports](https://github.com/antfu/unplugin-auto-import)\n  - [VueUse](https://github.com/antfu/vueuse) - a collection of useful functions\n- [Deep VS Code Integration](./.vscode/extensions.json)\n  - [IDE Capabilities](https://marketplace.visualstudio.com/items?itemName=vue.volar) - type hints, code completion, code formatting and more via Volar\n  - [Spell Checking](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - no more annoying typos to slip by!\n  - [Utility Class Intellisense](https://marketplace.visualstudio.com/items?itemName=voorjaar.windicss-intellisense) - Tailwind CSS (or Windi CSS) class name sorter\n\n#### Coding Style\n\n- [ESLint](https://eslint.org/) - statically analyzes, fixes and formats your code without the need of Prettier\n\nWhen using this framework, feel free to adjust it to your needs. It is \"simply\" is a set of rules to help you quickly \u0026 efficiently bootstrap \u0026 design component libraries, using industry best-practices.\n\n## 🧪 Testing\n\n```bash\npnpm test\n```\n\n## 📈 Changelog\n\nPlease see our [releases](https://github.com/openwebstacks/vue-starter/releases) page for more information on what has changed recently.\n\n## 💪🏼 Contributing\n\nPlease see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.\n\n## 🏝 Community\n\nFor help, discussion about best practices, or any other conversation that would benefit from being searchable:\n\n[Discussions on GitHub](https://github.com/openwebstacks/vue-starter/discussions)\n\nFor casual chit-chat with others using this package:\n\n[Join the Open Web Discord Server](https://discord.ow3.org)\n\n## 📄 License\n\nThe MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.\n\nMade with ❤️\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/@ow3/hello-world-vue?style=flat-square\n[npm-version-href]: https://npmjs.com/package/@ow3/hello-world-vue\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/@ow3/hello-world-vue?style=flat-square\n[npm-downloads-href]: https://npmjs.com/package/@ow3/hello-world-vue\n\n[github-actions-src]: https://img.shields.io/github/workflow/status/openwebstacks/vue-starter/CI/main?style=flat-square\n[github-actions-href]: https://github.com/openwebstacks/vue-starter/actions?query=workflow%3Aci\n\n\u003c!-- [codecov-src]: https://img.shields.io/codecov/c/gh/openwebstacks/vue-starter/main?style=flat-square\n[codecov-href]: https://codecov.io/gh/openwebstacks/vue-starter --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fow3org%2Fvue-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fow3org%2Fvue-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fow3org%2Fvue-starter/lists"}