Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greenteacake/gtc-components
https://github.com/greenteacake/gtc-components
stencil stenciljs typescript web-component web-component-starter web-component-tester web-components web-components-library webcomponent webcomponents
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/greenteacake/gtc-components
- Owner: GreenTeaCake
- License: mit
- Created: 2024-04-06T12:24:54.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-10T16:47:00.000Z (7 months ago)
- Last Synced: 2024-10-15T19:24:56.124Z (about 1 month ago)
- Topics: stencil, stenciljs, typescript, web-component, web-component-starter, web-component-tester, web-components, web-components-library, webcomponent, webcomponents
- Language: TypeScript
- Homepage:
- Size: 269 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Web Components Library
Component documentation:
- [switch](/src/components/switch/readme.md)
The generated Storybook site also provides for the components the auto-generated
documentation, interactive playground and accessibilty tests.
## Build Flow
### Pre-requisites
- [Node 20 'Iron' (LTS)](https://nodejs.org/en/download) is installed
> There is `.nvmrc` so you can go like this:
>
> ```shell
> # in workspace root
> $ nvm use
> ```
### Build and Check Code
```shell
# go to workspace root
$ cd
# install dependencies
$ npm install
# (optional) lint code
$ npm run lint
# (optional) format code
$ npm run format
# (optional) run tests
$ npm run test
# build the code
$ npm run build
# start dev environment at http://localhost:3333/
$ npm run build && npm run start
# start storybook (in dev mode) at http://localhost:6006/
$ npm run build && npm run storybook
# build storybook (in static mode to deploy)
$ npm run build && npm run storybook:build
# serve storybook (in static mode) at http://localhost:3000/
$ npm run build && npm run storybook:build && npm run storybook:serve
```