chore: add how to run project at local to readme.md
This commit is contained in:
parent
e563734af2
commit
66dabc2329
51
README.md
51
README.md
|
@ -18,9 +18,50 @@ Farris 设计原则:
|
|||
- <b>S</b>mart : 智能化的UI,满足开发智能应用的场景
|
||||
|
||||
|
||||
## 开始使用 Farris UI Vue
|
||||
## 1. 本地运行项目
|
||||
|
||||
### 1. 安装@farris/ui-vue
|
||||
### 1.1 检查环境
|
||||
|
||||
在本地运行项目前,请先执行以下命令检查环境中是否已经安装yarn。
|
||||
|
||||
```
|
||||
yarn -v
|
||||
```
|
||||
如果为得到`yarn`版本信息,请参考[安装yarn](https://yarnpkg.com/getting-started/install).
|
||||
|
||||
### 1.2 获取源代码
|
||||
|
||||
执行以下命令,获得项目源代码,并安装依赖组件。
|
||||
|
||||
```
|
||||
npm install lerna -g
|
||||
git clone https://gitee.com/ubml/farris-vue.git
|
||||
cd farris-vue
|
||||
lerna bootstrap
|
||||
```
|
||||
|
||||
### 1.3 运行示例站点
|
||||
|
||||
执行以下命令。
|
||||
```
|
||||
cd packages/ui-vue
|
||||
yarn run docs:dev
|
||||
```
|
||||
在浏览器中访问:`http://localhost:5173/`查看示例页面
|
||||
|
||||
![示例页面](./packages/ui-vue/docs/assets/farris_ui_vue_home.png)
|
||||
|
||||
### 1.4 使用示例站点
|
||||
|
||||
你可以在示例站点中:
|
||||
|
||||
- 点击「快速开始」了解如何安装使用 Farris UI Vue。
|
||||
- 点击「组件」体验组件视觉和交互效果,查看组件 API 说明文档。
|
||||
|
||||
|
||||
## 2. 开始使用 Farris UI Vue
|
||||
|
||||
### 2.1 安装@farris/ui-vue
|
||||
|
||||
```
|
||||
npm install @farris/ui-vue
|
||||
|
@ -30,7 +71,7 @@ npm install @farris/ui-vue
|
|||
yarn add @farris/ui-vue
|
||||
```
|
||||
|
||||
### 2. 在应用中引入 Farris UI Vue
|
||||
### 2.2 在应用中引入 Farris UI Vue
|
||||
|
||||
在`main.ts`文件中引入`@farris/ui-vue`。
|
||||
|
||||
|
@ -42,7 +83,7 @@ import Farris from '@farris/ui-vue'
|
|||
createApp(App).use(Farris).mount('#app')
|
||||
```
|
||||
|
||||
### 3. 在应用中使用 Farris UI Vue
|
||||
### 2.3 在应用中使用 Farris UI Vue
|
||||
|
||||
在`App.vue`文件中使用 Farris UI Vue 组件。
|
||||
|
||||
|
@ -52,7 +93,7 @@ createApp(App).use(Farris).mount('#app')
|
|||
</template>
|
||||
```
|
||||
|
||||
## 如何参与贡献
|
||||
## 3. 如何参与贡献
|
||||
|
||||
还原你参与贡献 Farris UI Vue
|
||||
在这里你可以参与以下贡献内容:
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 1.7 MiB |
Loading…
Reference in New Issue