https://github.com/pchalupa/custom-elements-kickoff

Custom elements kickoff template.
https://github.com/pchalupa/custom-elements-kickoff

eslint javascript jest jsdoc postcss stylelint

Last synced: about 2 months ago
JSON representation

Custom elements kickoff template.

• Host: GitHub
• URL: https://github.com/pchalupa/custom-elements-kickoff
• Owner: pchalupa
• Created: 2020-10-12T09:14:40.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-08T03:17:42.000Z (almost 2 years ago)
• Last Synced: 2024-10-28T13:45:57.872Z (3 months ago)
• Topics: eslint, javascript, jest, jsdoc, postcss, stylelint
• Language: JavaScript
• Homepage:
• Size: 2.26 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Custom Elements Kickoff

![CI](https://github.com/pchalupa/custom-elements-kickoff/workflows/CI/badge.svg)

Custom elements gives you ability to create own HTML element or extend existing one. This is starter template for this kind of project. You can read more about this feature [here](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements).

## Getting Started

Use this as [GitHub template](https://github.com/pchalupa/custom-elements-kickoff/generate) and then clone your generated repository. To install all NPM package run `npm i`.

## Development

To start development server, run `npm start`. This starts Webpack dev server on port 9000.

## Testing

Write your unit tests and run them by `npm test`.

## Production

To make production build, run `npm run build`. This compiles and minifies your code into dist folder.

## Workflows

There is allready prepared simple GitHub workflow. It tests youre code every time you push into repository.