element-plus/docs/en-US/guide/dev-guide.md
iamkun 6890afc149
chore: add missing docs (#10185)
Revert "chore: rm error doc (#10180)"

This reverts commit ceef0a56ec.
2022-10-21 14:48:25 +00:00

56 lines
874 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`
> App.vue
```vue
<template>
<ComponentYouAreDeveloping />
</template>
<script setup lang="ts">
// make sure this component is registered in @element-plus/components
import { ComponentYouAreDeveloping } from '@element-plus/components'
</script>
```
Modify `App.vue` file per your needs to get things work.