{"id":25440187,"url":"https://github.com/romhml/compodium","last_synced_at":"2025-05-15T13:34:23.494Z","repository":{"id":277840996,"uuid":"885590108","full_name":"romhml/compodium","owner":"romhml","description":"A plug and play component playground for Vue and Nuxt.","archived":false,"fork":false,"pushed_at":"2025-05-13T16:44:53.000Z","size":2589,"stargazers_count":146,"open_issues_count":5,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-13T16:49:35.225Z","etag":null,"topics":["components","documentation","nuxt","nuxt-module","vue"],"latest_commit_sha":null,"homepage":"https://compodium.dev","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/romhml.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-08T22:21:56.000Z","updated_at":"2025-05-13T16:44:56.000Z","dependencies_parsed_at":"2025-02-16T14:46:11.487Z","dependency_job_id":"d6a8e709-e999-4d8b-994b-5b0c73879079","html_url":"https://github.com/romhml/compodium","commit_stats":null,"previous_names":["romhml/compodium"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romhml%2Fcompodium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romhml%2Fcompodium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romhml%2Fcompodium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romhml%2Fcompodium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/romhml","download_url":"https://codeload.github.com/romhml/compodium/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254349528,"owners_count":22056369,"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":["components","documentation","nuxt","nuxt-module","vue"],"created_at":"2025-02-17T11:29:52.136Z","updated_at":"2025-05-15T13:34:23.476Z","avatar_url":"https://github.com/romhml.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \n# Compodium\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n\nA plug and play component playground for Vue and Nuxt.\n\n[Documentation](https://compodium.dev/getting-started)\n\n\u003c/div\u003e\n\n\u003e [!WARNING]\n\u003e This project is in its early stages and will evolve. Expect frequent updates and potential changes. Feedback is welcome!\n\n## Features\n\n- **Effortless Setup**: Simple setup process and minimal maintenance, allowing you to focus on building components.\n- **No Stories Required**: Analyzes your component code directly, eliminating the need to write stories.\n- **Fast**: Built on top of Vite for rapid development and instant feedback, enhancing productivity.\n- **DevTools Integration**: Integrates with Vue and Nuxt devtools for a cohesive development experience.\n- **UI Library Integrations**: Integrates with popular UI libraries, showcasing examples for locally installed components.\n- **Code generation**: Generates up-to-date template code based on component props, ready to copy and use instantly.\n\n\n## Installation\n\n### Nuxt\n\n```bash\nnpx nuxi@latest module add --dev compodium\n```\n\n### Vue\n\n1. Install `@compodium/vue`\n\n```bash [pnpm]\npnpm add -D @compodium/vue\n```\n\n```bash [yarn]\nyarn add --dev @compodium/vue\n```\n\n```bash [npm]\nnpm install --save-dev @compodium/vue\n```\n\n```bash [bun]\nbun add -D @compodium/vue\n```\n\n2. Add the Compodium plugin in your `vite.config.ts`:\n\n```ts [vite.config.ts]\nimport { defineConfig } from 'vite'\nimport vue from '@vitejs/plugin-vue'\nimport vueDevTools from 'vite-plugin-vue-devtools'\nimport { compodium } from '@compodium/vue'\n\nexport default defineConfig({\n  plugins: [\n    vue(),\n    vueDevTools(),\n    compodium()\n  ]\n})\n```\n\n3. Include compodium types in your `tsconfig.app.json`\n\n```json [tsconfig.app.json]{6}\n{\n  \"include\": [\n    \"src/**/*.ts\",\n    \"src/**/*.tsx\",\n    \"src/**/*.vue\",\n    \"node_modules/@compodium/vue/dist/index.d.ts\"\n  ],\n}\n```\n\n## Contribution\nContributions are welcome! ♥️\n\nCurrently, one way you can contribute is by adding examples for your favorite component library. You can find the Nuxt UI collection and examples [here](https://github.com/romhml/compodium/tree/main/packages/examples/src/index.ts).\n\n**Local development**\n\n```bash\n# Install dependencies\npnpm install\n\n# Generate type stubs\npnpm dev:prepare\n\n# Develop with the playground\npnpm dev\n\n# Run ESLint\npnpm lint\n\n# Run typechecks \npnpm typechecks \n\n# Run Vitest\npnpm test\n```\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/%40compodium%2Fcore/latest.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[npm-version-href]: https://npmjs.com/package/%40compodium%2Fcore\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/compodium.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[npm-downloads-href]: https://npm.chart.dev/%40compodium%2Fcore\n\n[license-src]: https://img.shields.io/npm/l/compodium.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[license-href]: https://npmjs.com/package/compodium\n\n[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromhml%2Fcompodium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromhml%2Fcompodium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromhml%2Fcompodium/lists"}