{"id":16191379,"url":"https://github.com/christiankienle/cdk","last_synced_at":"2025-03-16T10:32:29.023Z","repository":{"id":36589607,"uuid":"217751817","full_name":"ChristianKienle/cdk","owner":"ChristianKienle","description":"🎁 Vue Component Development Kit","archived":false,"fork":false,"pushed_at":"2023-01-13T04:30:08.000Z","size":42113,"stargazers_count":85,"open_issues_count":33,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-11T07:45:51.720Z","etag":null,"topics":["front-end-development","vue-components","vuejs","webdevelopment","webpack"],"latest_commit_sha":null,"homepage":"https://christiankienle.github.io/cdk/","language":"JavaScript","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/ChristianKienle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-26T18:25:20.000Z","updated_at":"2024-07-16T18:21:49.000Z","dependencies_parsed_at":"2023-01-17T03:00:29.784Z","dependency_job_id":null,"html_url":"https://github.com/ChristianKienle/cdk","commit_stats":null,"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChristianKienle%2Fcdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChristianKienle%2Fcdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChristianKienle%2Fcdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChristianKienle%2Fcdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChristianKienle","download_url":"https://codeload.github.com/ChristianKienle/cdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221663082,"owners_count":16859779,"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":["front-end-development","vue-components","vuejs","webdevelopment","webpack"],"created_at":"2024-10-10T07:46:07.447Z","updated_at":"2024-10-27T10:27:35.352Z","avatar_url":"https://github.com/ChristianKienle.png","language":"JavaScript","funding_links":[],"categories":["Components \u0026 Libraries","Frameworks [🔝](#readme)"],"sub_categories":["Frameworks"],"readme":"# Vue Component Development Kit\nInspired by [Angular CDK](https://material.angular.io/cdk)  😍.\n\nEverything in VCDK should be in it's own package and consumable as such.\n\n## Using this Repository\nThis repository is using [Lerna](https://lerna.js.org/). The current lerna configuration is not yet completly done – there are certain things (not all related to Lerna) that I would like to see improved. More about those known issues later. First things first:\n\nAfter cloning this repository you should run:\n\n```sh\n$ yarn install\n```\n\nThis will install all dependencies and automatically execute `lerna bootstrap` afterwards. `lerna bootstrap` will in turn initialize Lerna and all sub-projects.\n\n### Documentation\nThe documentation is not a single thing. It consists of several things in order to accomodate the need of each use-case and target audience.\n\n#### The *user-facing* documentation\nThe user-facing documentation is a standard [VuePress](https://v1.vuepress.vuejs.org/) installation. You run it by executing:\n\n```sh\n$ yarn docs\n```\n\nEverything that goes into *Vue Component Development Kit* should be relfected somewhere in the user-facing documentation. The user-facing documentation is what developers will first go to in case of questions/need for information. Because of that it should contain everything in a single place:\n\n- Installation instructions\n- A Guide which explains concepts and background information\n- Live examples\n- Copy and pasteable code snippets\n- **API reference**\n\nThe API reference is realized by a custom VuePress plugin which is using [vuese](https://github.com/vuese) under the hood. It works like this:\n\n- You document your component by using comments. Refer to already existing components to get an idea how the components should look like.\n- You have to tell the API plugin where to find your documented component. To do this add an entry to `docs/docs/.vuepress/config.js` (to the `APIPlugin`-options-object). For each and every file the plugin will create a new page at `/api/$component-name/index.html` that contains the rendered API documentation. You can then link to that site from within your guide/main component documentation.\n\n**Building the user–facing Documentation**\n\nYou can create a production build by executing:\n\n```sh\n$ cd docs # skip if you are already in the docs-dir\n$ yarn build\n```\n\nIf you want to change the `base` of the statically generated site simply set the `VCDK_BASE` environment variable to the `base` you want:\n\n```sh\n$ cd docs # skip if you are already in the docs-dir\n$ ./../node_modules/.bin/cross-env VCDK_BASE=/ yarn build\n```\n\nThis also works when building the whole documentation (see below).\n\n#### Running the Storybook\nThe storybook is mainly used during the development of *Vue Component Development Kit*. You can run it by executing:\n\n```sh\n$ yarn storybook\n```\n\nThe storybook is not the main documentation. It is intended to be used by people who are contributing to *Vue Component Development Kit*.\n\n#### Building the whole Documentation\nYou can create a production build of the whole documentation by executing\n\n```sh\n$ yarn docs:build\n```\n\nfrom the root of the project. This will create a static production–ready build of both, the user facing documentation (`/docs`) and the Storybook (`/storybook`).\n\n## Making a Release\n```sh\n$ ./node_modules/.bin/lerna publish patch\n```\n\n## Known Issues\nThere are a lot of known issues:\n\n- The documentation will throw errors from time to time (in dev-mode). This seems to be a VuePress-problem we can't do anything about. I am thinking about moving away from VuePress since it is really annoying.\n- The unit test-setup is not finished yet. I have executed tests already but there is no uniform way to write/execute tests.\n- The end-to-end-test-setup is also not finished yet. Again: I have executed end-to-end-tests but there is no uniform/consistent way of executing end-to-end-tests.\n- No consistent linter setup\n- Dependencies are a mess: When is something only a peerDependency and when is something a real dependency?\n- `base` is hardcoded.\n- No CI setup\n- No automated release\n- Currently Lerna would simply publish the source code of every package without building it first. This will work for every consumer that is using Webpack but thats about it.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristiankienle%2Fcdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristiankienle%2Fcdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristiankienle%2Fcdk/lists"}