Chico UI 技术文档

1. 安装指南

1.1 使用 npm 安装

Chico UI 可以通过 npm 进行安装。打开终端并运行以下命令：

$ npm install chico

1.2 安装特定版本

如果你需要安装特定版本的 Chico UI，请查看 releases 页面，找到你需要的版本号，然后使用以下命令安装：

$ npm install chico@<version>

2. 项目的使用说明

2.1 开发环境设置

在开始开发之前，请确保你已经安装了以下工具：

• Git
• Node.js

2.2 克隆仓库并安装依赖

1. 首先，克隆仓库并创建一个新的分支：

   $ git clone https://github.com/mercadolibre/chico.git
   $ cd chico
   $ git checkout -b <your-branch-name>
   

2. 安装项目依赖：

   $ npm install
   

3. 安装 Gulp 和 Browsersync：

   $ npm install gulp -g
   $ npm install browser-sync -g
   

4. 运行开发任务：

   $ gulp dev
   

   这将会在浏览器中打开 UI 版本，地址为 http://localhost:3040，移动版本地址为 http://localhost:3040/mobile。

2.3 代码风格和格式化

确保你的代码符合以下代码风格指南：

• CSS 风格指南
• JavaScript 风格指南

3. 项目API使用文档

3.1 运行测试

你可以使用以下命令运行所有测试：

$ npm test

这将使用 PhantomJS 在终端中运行所有测试。如果你希望在其他浏览器中运行测试，例如 Google Chrome，可以使用以下命令：

./node_modules/.bin/karma start --browsers Chrome

4. 项目安装方式

4.1 通过 npm 安装

Chico UI 可以通过 npm 进行安装，具体步骤请参考 安装指南。

4.2 从源码安装

如果你希望从源码进行安装，可以按照以下步骤操作：

1. 克隆仓库：

   $ git clone https://github.com/mercadolibre/chico.git
   

2. 进入项目目录并安装依赖：

   $ cd chico
   $ npm install
   

3. 运行开发任务：

   $ gulp dev
   

通过以上步骤，你可以在本地环境中运行和开发 Chico UI 项目。