mirror of
https://github.com/element-plus/element-plus.git
synced 2025-08-15 11:34:06 +08:00
9539c19b40
* style(eslint-config): add rules to restrict the imports of element-plus * chore: added validation for tsx files * chore: revert the shell
53 lines
804 B
Markdown
53 lines
804 B
Markdown
---
|
|
title: Local Development
|
|
lang: en-US
|
|
---
|
|
|
|
# Local Development
|
|
|
|
## Bootstrap project
|
|
|
|
With command
|
|
|
|
```shell
|
|
pnpm i
|
|
```
|
|
|
|
the project will install all dependencies.
|
|
|
|
## Website preview
|
|
|
|
With command
|
|
|
|
```shell
|
|
pnpm docs:dev
|
|
```
|
|
|
|
the project will launch website for you to preview all existing component.
|
|
|
|
## Local development
|
|
|
|
See [Local development guide](https://github.com/element-plus/element-plus/blob/dev/CONTRIBUTING.md)
|
|
|
|
1. With command
|
|
|
|
```shell
|
|
pnpm dev
|
|
```
|
|
|
|
will start the local development environment.
|
|
|
|
2. Add your component into `play/src/App.vue`
|
|
|
|
```vue [App.vue]
|
|
<template>
|
|
<ComponentYouAreDeveloping />
|
|
</template>
|
|
|
|
<script setup lang="ts">
|
|
// make sure this component is registered in @element-plus/components
|
|
</script>
|
|
```
|
|
|
|
Modify `App.vue` file per your needs to get things work.
|