{"id":13407017,"url":"https://github.com/DesignRevision/shards-vue","last_synced_at":"2025-03-14T11:30:56.496Z","repository":{"id":32973338,"uuid":"148300964","full_name":"DesignRevision/shards-vue","owner":"DesignRevision","description":"🌟Shards Vue is a free, beautiful and modern Vue.js UI kit based on Shards.","archived":false,"fork":false,"pushed_at":"2022-12-09T13:00:14.000Z","size":1922,"stargazers_count":395,"open_issues_count":27,"forks_count":40,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-08T17:56:55.668Z","etag":null,"topics":["bootstrap","components","design","designsystem","free","modern","ui","uikit","vue"],"latest_commit_sha":null,"homepage":"https://designrevision.com/docs/shards-vue/","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/DesignRevision.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-11T10:32:37.000Z","updated_at":"2025-01-03T21:59:35.000Z","dependencies_parsed_at":"2023-01-14T23:00:49.891Z","dependency_job_id":null,"html_url":"https://github.com/DesignRevision/shards-vue","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesignRevision%2Fshards-vue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesignRevision%2Fshards-vue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesignRevision%2Fshards-vue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesignRevision%2Fshards-vue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DesignRevision","download_url":"https://codeload.github.com/DesignRevision/shards-vue/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243401508,"owners_count":20285057,"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":["bootstrap","components","design","designsystem","free","modern","ui","uikit","vue"],"created_at":"2024-07-30T19:02:45.985Z","updated_at":"2025-03-14T11:30:56.473Z","avatar_url":"https://github.com/DesignRevision.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"logo.jpg\" width=\"230\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\nShards Vue is a free, beautiful and modern Vue.js UI kit \u003cbr /\u003e based on \u003ca href=\"https://github.com/designrevision/shards-ui\"\u003eShards\u003c/a\u003e.\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-MIT-brightgreen.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/designrevision\"\u003e\n    \u003cimg src=\"https://img.shields.io/twitter/follow/DesignRevision.svg?style=social\u0026label=Follow\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://designrevision.com/docs/shards-vue/\"\u003e\u003cstrong\u003eDocumentation \u0026 Demo\u003c/strong\u003e\u003c/a\u003e •\n  \u003ca href=\"https://designrevision.com/downloads/shards-vue/\"\u003e\u003cstrong\u003eOfficial Page\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n### Getting Started\n\nGetting started with Shards Vue is fairly simple. You can download Shards Vue via the official website, here on GitHub as a release package or by using a package manager such as Yarn or NPM.\n\n* [Official Website](https://designrevision.com/download/shards-vue)\n* [Release Package](https://github.com/DesignRevision/shards-vue/releases)\n\n\u003cbr /\u003e\n\n### Quick Start\n\nYou can install Shards Vue via Yarn or NPM.\n\n```bash\n// Install via Yarn\nyarn add shards-vue\n\n// Install via NPM\nnpm i shards-vue\n```\n\n\u003cbr /\u003e\n\n### Module Bundlers\n\nIf you are using a module bundler such as [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/), you can include the entire Shards Vue library inside your project.\n\n```javascript\nimport Vue from 'vue'\nimport ShardsVue from 'shards-vue'\n\n// Import base styles (Bootstrap and Shards)\nimport 'bootstrap/dist/css/bootstrap.css'\nimport 'shards-ui/dist/css/shards.css'\n\nVue.use(ShardsVue);\n```\n\n\u003cbr /\u003e\n\n### Registering Components as Vue Plugins\n\nIf you'd like to register only certain components as Vue plugins, make sure to import just the component you'd like to use.\n\n```javascript\nimport Vue from 'vue'\n\n// Import base styles (Bootstrap and Shards)\nimport 'bootstrap/dist/css/bootstrap.css'\nimport 'shards-ui/dist/css/shards.css'\n\nimport { Button } from 'shards-vue/src/components'\nVue.use(Button)\n\n```\n\n\u003cbr /\u003e\n\n### Importing Single File Components\n\nImporting single file components is also possible.\n\n```vue\n\u003ctemplate\u003e\n    \u003cd-button @click=\"handleClick\"\u003eClick Me!\u003c/d-button\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\nimport dButton from 'shards-vue/src/components/button/Button'\n\nexport default {\n    components: {\n        dButton\n    },\n    methods: {\n        handleClick() {\n            alert('You just clicked me!')\n        }\n    }\n}\n\u003c/script\u003e\n```\n\n\u003cbr /\u003e\n\n### File Sizes\n\nYou can also run `yarn bundlesize` at any time to check the compiled file sizes.\n\n| File Name                | Size (min.gz) |\n|--------------------------|---------------|\n| shards-vue.common.min.js | 46.29KB       |\n| shards-vue.esm.min.js    | 46.24KB       |\n| shards-vue.umd.min.js    | 39.3KB        |\n\n\u003cbr /\u003e\n\n### Built Using\n\n* [Shards UI Kit](https://designrevision.com/downloads/shards/)\n* [noUiSlider by Léon Gersen (WTFPL License)](https://refreshless.com/nouislider/download/)\n* [vuejs-datepicker](https://github.com/charliekassel/vuejs-datepicker)\n\n\u003cbr /\u003e\n\n### Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\nIf you'd like to fix a bug or work on a feature, make sure to follow the steps below in order to setup the development environment on your local machine:\n\n1. Clone the repository.\n2. Run `yarn` to install all required dependencies.\n3. Install Vue CLI and the CLI service globally by running: `npm i -g @vue/cli @vue/cli-service-global` or `yarn global add @vue/cli-service-global`.\n4. Run `yarn watch` in order to kickstart the server and run the sandbox with hot reloading.\n5. Refer to the `sandbox/Sandbox.vue` file for more details.\n\n\u003cbr /\u003e\n\n### Roadmap\n\n[View the roadmap.](http://designrevision.com/docs/shards-vue/roadmap)\n\n\u003cbr /\u003e\n\n### Changelog\n\n[View notable changes.](CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDesignRevision%2Fshards-vue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDesignRevision%2Fshards-vue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDesignRevision%2Fshards-vue/lists"}