English | 简体中文
A UI library base on BlueKing Magicbox and Vue3
yarn install
yarn dev
yarn build
yarn test
yarn lint
- Save your svg to the
packages/icon/src/svgdirectory - Rename to a recognizable English name used by your icon
- Execute the command
yarn generate:icon - Use similar syntax
import { HelpFill } from '@bkui-vue/icon/';in the component to reference
To quickly start using containerization, you can refer to the following steps to quickly deploy and start on a containerized server.
# Build the local image
docker build -t bkui-vue3 .
# Run the container
docker run -p 8086:8086 bkui-vue3
# Development and debugging
docker run -it -p 8086:8086 -v $(pwd):/app bkui-vue3
If you want to contribute code, it is recommended to refer to the existing feature documentation and development environment build documentation first. You can run yarn cc and enter the component name to generate a new component template
In order to standardize the commit-msg format, it is recommended to use yarn cz to automatically generate commit-msg, with different commit markers to standardize and differentiate the commit content:
<tag>(<component name>): [submitted summary notes] issue #[123]
// Skip a line
<details of this change>
// Skip a line
<footer>
example:
chore(common): Standard component library development process
affects: bkui-vue, @bkui-vue/button, @bkui-vue/checkbox, @bkui-vue/input, @bkui-vue/radio
Allow a single component to execute jest tasks
Add husky submission process verification
Add chanelog automatic generation mechanism
ISSUES CLOSED: #1| tag | description |
|---|---|
| feature/feat | new feature development |
| bug/fix/bugfix | bug fix |
| refactor/perf | refactor code/optimize configuration & parameters/optimize logic and functions |
| test | add unit test case related |
| docs | add document |
| info | add comment information |
| format | Without modifying the business logic, only format the code specification |
| merge | only do branch merge sync |
| depend | add, delete and modify the dependencies of the project |
| chore | build scripts, tasks and other related code |
| del | remove disruptive actions such as features, APIs, etc. that may still be used |