# 快速上手

### 背景知识

使用 KY Weapp 前，请确保你已经学习过微信官方的 [小程序简易教程](https://mp.weixin.qq.com/debug/wxadoc/dev/) 和 [自定义组件介绍](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/)。

## 安装

### 步骤一 通过 npm 安装

注：安装时不用切换npm库，使用原始的https://registry.npmjs.org/ npm库即可

```bash
# 通过 npm 安装
npm install -g ky-weapp-cli
-任意文件夹运行ky-weapp-cli init
-输入文件夹名称如testapp
-选择对应的Taro框架版本
-初始化小程序项目成功

# 通过 git 安装
http://git.sf-express.com/projects/EOS-FOP/repos/eos-fop-eps-weapp-cli/browse
-切换到git项目处运行npm install
-切换到git项目处运行npm link
-任意文件夹运行ky-weapp-cli init
-输入文件夹名称如test-app
-选择对应的Taro框架版本
-初始化小程序项目成功

```


### 步骤二 修改 config.js

如果你使用 KY-Weapp 开发小程序，需要在config.js 中增加如下配置，防止 Taro 构建后 组件

请将`config/index.js`修改为构建后所在的目录

```json
{
  "copy": {
      "patterns": [
        {"from": 'src/vant/', to: 'dist/vant/'},

      ],
      "options": {}
    }
}
```

## 使用

### 引入组件

以 Button 组件为例，只需要在`index.config.jsx`中配置 Button 对应的路径即可。

```json

"usingComponents": {
 "van-button": "@path/to/vant/button/index"
}
```

### 使用组件

引入组件后，可以在 wxml 中直接使用组件

```xml
<van-button type="primary">按钮</van-button>
```

## 其他

### 在开发者工具中预览示例小程序

```bash

# 将项目克隆到本地
npm install -g ky-weapp-cli
ky-weapp-cli init testapp

# 安装项目依赖
cd testapp && npm install

# 执行组件编译
npm run dev:weapp

```

接着打开微信开发者工具，导入`dist`目录的项目就可以预览示例了。