{"id":22083184,"url":"https://github.com/m4thieulavoie/webcomponents-starter","last_synced_at":"2025-07-24T16:30:55.166Z","repository":{"id":37048271,"uuid":"322908181","full_name":"m4thieulavoie/webcomponents-starter","owner":"m4thieulavoie","description":"Starter project with Web Components, TypeScript and Webpack support out of the box","archived":false,"fork":false,"pushed_at":"2024-05-18T00:38:21.000Z","size":2275,"stargazers_count":5,"open_issues_count":10,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-18T12:35:14.544Z","etag":null,"topics":["html","javascript","sass","typescript","vaadin","web-components","webcomponents","webpack"],"latest_commit_sha":null,"homepage":"","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/m4thieulavoie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-12-19T18:05:58.000Z","updated_at":"2024-05-30T07:27:39.928Z","dependencies_parsed_at":"2023-12-26T01:44:07.847Z","dependency_job_id":"b196e3df-2ddd-4b36-9fb2-1bb93f397119","html_url":"https://github.com/m4thieulavoie/webcomponents-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4thieulavoie%2Fwebcomponents-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4thieulavoie%2Fwebcomponents-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4thieulavoie%2Fwebcomponents-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m4thieulavoie%2Fwebcomponents-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m4thieulavoie","download_url":"https://codeload.github.com/m4thieulavoie/webcomponents-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227456739,"owners_count":17777943,"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":["html","javascript","sass","typescript","vaadin","web-components","webcomponents","webpack"],"created_at":"2024-12-01T00:10:56.666Z","updated_at":"2024-12-01T00:10:57.267Z","avatar_url":"https://github.com/m4thieulavoie.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# webcomponents-starter\n\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)\n[![CircleCI](https://circleci.com/gh/circleci/circleci-docs.svg?style=shield)](https://circleci.com/gh/m4thieulavoie/webcomponents-starter)\n\n`webcomponents-starter` aims to be a battery-included starter project for any Web Components enthousiasth. Its goal is to accelerate your development process by providing all the behind-the-scenes tools, such as\n\n- Webpack\n- Typescript\n- SASS\n- Prettier/eslint/stylelint\n- A few Web Components examples (Made with FAST here)\n- vaadin router\n\nThis repo is based on this [vaadin article](https://vaadin.com/learn/tutorials/using-web-components) for Web Components in Webpack, and this [Webpack article](https://webpack.js.org/guides/typescript/) for the Typescript support\n\n## Getting started\n\n### Clone the project\n\n```bash\ngit clone git@github.com:m4thieulavoie/webcomponents-starter.git\n```\n\n### Install dependencies\n\nThen, to init the project\n\n```bash\ncd webcomponents-starter\nnpm install\n```\n\n### Start the project\n\nIf you want to run the project, simply run\n\n```bash\nnpm start\n```\n\n`Webpack` will then indicate you to open `localhost:3000`. When you'll do so, you'll see the project running.\n\n## Web Components\n\n### Underlying framework\n\nFor the sake of this project, we rely on [FAST Components](https://github.com/microsoft/fast) to accelerate the development of components. Definitely feel free to get rid of the dependency and add your favourite framework if you feel like it!\n\n### Polyfills\n\nWe provide `@webcomponents/webcomponentsjs` in the project, but disabled it by default (for bundle size reasons). If you want to support older browsers, head in `index.ts` and uncomment the line that `require`s `webcomponentsjs`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm4thieulavoie%2Fwebcomponents-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm4thieulavoie%2Fwebcomponents-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm4thieulavoie%2Fwebcomponents-starter/lists"}