-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bd52ca7
commit 6efb7fb
Showing
7 changed files
with
187 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,48 @@ | ||
# Web Components Library | ||
|
||
List of components: | ||
|
||
- [switch](/src/components/switch/readme.md) | ||
|
||
## 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 <workspace_root> | ||
|
||
# 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 | ||
$ pnpm run build | ||
|
||
# start development environment at http://localhost:3333/ | ||
# ! code should be pre-built for that | ||
$ pnpm run build && pnpm run start | ||
|
||
# start storybook to access it at http://localhost:6006/ | ||
# ! code should be pre-built for that | ||
$ pnpm run build && pnpm run storybook | ||
``` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters