element-plus/README.md

38 lines
674 B
Markdown
Raw Normal View History

2020-07-24 20:34:25 +08:00
# Element-Plus
## Bootstrap project
With command
```bash
$ yarn bootstrap
```
the project will install all dependencies and run `lerna bootstrap` to initialize the project
## Storybook preview
With command
```bash
$ yarn storybook
```
the project will launch `@storybook` client for you to preview all existing component
## Generate new component
With command
```bash
$ yarn gen component-name
```
Note the `component-name` must be in `kebab-case`, combining words by replacing each space with a dash.
2020-07-30 10:30:18 +08:00
## Commit template
With command
```bash
yarn cz
```
Example
```
[TYPE](SCOPE):DESCRIPTION#[ISSUE]
# example feat(button):add type 'button' for form usage #1234
```