{"id":26175438,"url":"https://github.com/break-stuff/lit-starter-kit","last_synced_at":"2025-10-09T19:34:42.657Z","repository":{"id":266001427,"uuid":"896079841","full_name":"break-stuff/lit-starter-kit","owner":"break-stuff","description":"A starter kit for creating a Lit-based web component library.","archived":false,"fork":false,"pushed_at":"2025-01-14T22:04:06.000Z","size":389,"stargazers_count":27,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-14T21:35:29.897Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/break-stuff.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-29T13:59:16.000Z","updated_at":"2025-04-10T08:22:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"6ea9603c-212c-42f4-964e-ff581d9fb73b","html_url":"https://github.com/break-stuff/lit-starter-kit","commit_stats":null,"previous_names":["break-stuff/lit-starter-kit"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/break-stuff/lit-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/break-stuff%2Flit-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/break-stuff%2Flit-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/break-stuff%2Flit-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/break-stuff%2Flit-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/break-stuff","download_url":"https://codeload.github.com/break-stuff/lit-starter-kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/break-stuff%2Flit-starter-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001959,"owners_count":26083244,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-03-11T20:56:33.304Z","updated_at":"2025-10-09T19:34:42.613Z","avatar_url":"https://github.com/break-stuff.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lit Starter Kit\n\nWelcome to the Lit Starter Kit. This is not an official kit for the Lit library, but this is a tool to get a component library up and running quickly.\n\n## Features\n\nThis repository is designed to be a \"batteries included\" repo, so you can hit the ground running with what you need to start delivering components. This repo includes:\n\n- ✅ Library and component scaffolding\n- ✅ [Storybook](https://storybook.js.org/docs/get-started/frameworks/web-components-vite?renderer=web-components) integration (with [helpers](https://www.npmjs.com/package/wc-storybook-helpers))\n- ✅ CDN build (in `/cdn`)\n- ✅ NPM build (in `/dist`)\n- ✅ Testing\n- ✅ Documentation\n- ✅ [React wrappers](https://www.npmjs.com/-package/custom-element-react-wrappers) (in - `/react`)\n- ✅ [JSX integration](https://www.npmjs.com/-package/custom-element-jsx-integration) - (in `/types`)\n- ✅ [Vue.js integration](https://www.npmjs.-com/package/-custom-element-vuejs-integration) (in `/- types`)\n- ✅ [Svelte integration](https://www.npmjs.-com/package/-custom-element-svelte-integration) (in `/- types`)\n- ✅ [SolidJS integration](https://www.npmjs.-com/package/-custom-element-solidjs-integration) (in `/- types`)\n- ✅ [HTML linter](https://www.npmjs.com/package/eslint-plugin-custom-element) (in `/eslint`)\n\n## Getting Started\n\nYou can choose to fork this repository directly or you can run the following command to create a new project.\n\n```bash\nnpm init lit-starter-kit your-project-name\n```\n\n## Running the Code\n\nThe development environment uses [Storybook](https://storybook.js.org/) to showcase and document the components. The documentation files are written in MDX files to increase portability in case you wan to use a different tool for documenting your components.\n\n```bash\nnpm run dev\n```\n\n### Creating a New Component\n\nThis project leverages [plop](https://www.npmjs.com/package/plop) to generate new components in your library. You can create a new component by running the following command and following the prompts.\n\n```bash\nnpm run new\n```\n\n## Building the Project\n\nGenerating the final build assets will generate the `dist` assets for the NPM package, the content for the CDN located in the `cdn` directory at the root of the project, as well as the meta content for your components like framework integrations like types and react wrappers.\n\n```bash\nnpm run build\n```\n\n## Testing the Components\n\nTests are written and executed using [web-test-runner](https://modern-web.dev/docs/test-runner/overview/) which execute your tests in _real_ browsers to validate your APIs are working as expected in the environments you intend to be using them in.\n\nTests can be configured in the `web-test-runner.config.js` file located at the root of the project.\n\nTests can be run using the following command:\n\n```bash\nnpm test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreak-stuff%2Flit-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbreak-stuff%2Flit-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreak-stuff%2Flit-starter-kit/lists"}