create-arco-pro/README.md

A template to quickly initialize an Arco project

<div align="center">

<h1 align="center">Create Arco</h1>
<p align="center">一个能够快速搭建 Arco 模板项目的命令行工具</p> 
  
![Static Badge](https://img.shields.io/badge/%E8%B6%85%E7%BA%A7%E5%BF%AB%E7%9A%84Cli%20-bright?logo=bytedance&color=%23fff)
![NPM Version](https://img.shields.io/npm/v/create-arco?logo=npm&logoColor=%23CB3837&label=version&labelColor=%23E8F3FF&color=%23165DFF)
![GitHub License](https://img.shields.io/github/license/oljc/create-arco?labelColor=%23404040&color=%2300B42A)
![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/create-arco?label=mini%20size&labelColor=%231d2129&color=%230E42D2)
![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/create-arco?logo=javascript&color=%233491FA)

</div>

## 功能

- 速度快（中国地区加速）
- 支持 Vue 和 React 两种技术栈
- 提供多种模板选择（官方基础版、官方完整版、社区开源模板）
- 简洁的交互式界面，傻瓜式快速生成项目

![shot](https://github.com/user-attachments/assets/26c165f4-e99e-4318-bf13-fe90b9d382d2)

## 🏷️ 使用

运行以下任意命令，按照步骤选择即可在当前目录下创建一个 Arco 模板项目

```
包管理器 create arco 项目名(可不填)
```

或

```
包管理器 create arco-pro 项目名(可不填)
```

### Pnpm：

```sh
pnpm create arco@latest
```

### Yarn：

```sh
yarn create arco@latest
```

### NPM：

```sh
npm create arco@latest
```

### npx

```sh
npx create-arco@latest
```

> [!TIP]
> 推荐@latest 保持使用最新版本
>
> ```sh
>  pnpm create arco@latest <项目名>
> ```

## ⚙️ 配置选项

| 参数            | 说明 | 描述               |
| --------------- | ---- | ------------------ |
| `--version, -v` | 版本 | 查看当前工具版本号 |
| `--help, -h`    | 帮助 | 查看帮助信息       |

## 支持模板

我们支持开源社区提供的模板！你可以从以下模板中选择一个开始你的项目

| 项目                                                   | 框架    | 推荐管理器 | 描述                                                                               |
| ------------------------------------------------------ | ------- | ---------- | ---------------------------------------------------------------------------------- |
| [Arco Design Pro](https://react-pro.arco.design)       | `React` | `pnpm`     | 开箱即用的中后台前端解决方案                                                       |
| [Arco Design Pro Vue](https://vue-pro.arco.design)     | `Vue`   | `pnpm`     | Arco 官网版 开箱即用的中后台前端解决方案                                           |
| [Arco Admin ](https://github.com/oljc/arco-admin)      | `Vue`   | `pnpm`     | Vite5 + vue3 + Arco + TypeScript                                                   |
| [Gi Admin Pro](https://gitee.com/lin0716/gi-demo)      | `Vue`   | `npm`      | 一个基于 Vue3、Vite、TypeScript、Arco Design Vue、Pinia、VueUse 等的免费中后台模版 |
| [Fantastic Admin](https://fantastic-admin.hurui.me/)   | `Vue`   | `pnpm`     | 杰出的管理系统框架, 开箱即用，提供舒适开发体验                                     |
| [Arco Work](https://github.com/qingqingxuan/arco-work) | `Vue`   | `npm`      | Vue Admin Work 系列中成熟和完善的中后台框架                                        |

> [!NOTE]
> 模板列表排名不分先后，按加入时间排序。  
> 如果你希望将自己的开源项目添加到模板列表中，请提交 Issue 或发起 Pull Request，我们会尽快审核和更新！

## 🪛 环境支持

- Node.js >= 14.0.0
- 支持的包管理器：pnpm、yarn、npm

## 贡献

如果你有好的意见或建议，欢迎给我们提 [issue](https://github.com/oljc/create-arco/issues)

## 📑 开源协议

[MIT](./LICENSE) License © 2025 [oljc](https://github.com/oljc)