I made an open source GitHub template to help me spin up new Web Components, and I thought you might find it useful as well.
GitHub - daviddarnes/component-template: Template for kicking off a new Web Component
Template for kicking off a new Web Component. Contribute to daviddarnes/component-template development by creating an account on GitHub.
daviddarnes
Features
- Web Component JavaScript starter file
- Demo HTML file to demonstrate the component, can be used in conjunction with GitHub Pages
- Package JSON file for deploying to things like npm
- A publish to npm GitHub workflow file to automatically deploy release to the npm registry
- Issue templates for bug reports and feature requests
- Example readme file to show examples, installation instructions and more
- Suggestions for tags so your Web Component can be found on GitHub
How to use it
Hit the 'Use this template' button on the repo itself, name it to the component name you want, replace component-name with your component name in your newly created repo and you're off!
Oh and don't forget to let me know if you decided to use this template to make your own Web Component 😊
Credit
Credit to Zach Leatherman who had some very nice conventions in his own Web Components that I was very much inspired by.
Zach Leatherman—zachleat.com
A post by Zach Leatherman (zachleat)
Zach Leatherman