🍃 秋夜前端脚手架工具 (Qiuye FE CLI)

一个现代化的前端项目脚手架工具，帮助你快速创建基于最佳实践的前端项目模板。

✨ 特性

• 🚀 快速创建 - 一键生成完整的前端项目结构
• 🎨 交互式界面 - 友好的命令行交互体验
• 📦 模板丰富 - 支持多种前端框架模板
• 🔧 易于扩展 - 简单的模板配置，轻松添加新模板
• 💡 智能提示 - 详细的错误提示和使用指导

📦 安装

全局安装

npm install -g qiuye-fe-cli

使用 npx (推荐)

npx qiuye-fe-cli create my-project

🚀 使用方法

创建新项目

# 交互式创建项目
qiuye create

# 直接指定项目名称
qiuye create my-awesome-project

# 使用 npx（无需全局安装）
npx qiuye-fe-cli create my-project

查看可用模板

qiuye list

查看帮助信息

qiuye --help
qiuye create --help

查看版本

qiuye --version

📋 可用模板

React 项目模板

• 描述: 基于 React + TypeScript + Vite 的现代化前端项目模板
• 包含: React 18, TypeScript, Vite, Ant Design, Tailwind CSS, Zustand, React Router, i18n
• 适用场景: 现代化的 React 单页应用开发

更多模板正在开发中...

🛠️ 开发

本地开发

# 克隆仓库
git clone https://github.com/QiuYeDx/qiuye-fe-cli.git
cd qiuye-fe-cli

# 安装依赖
npm install

# 本地链接（用于测试）
npm link

# 测试命令
qiuye create test-project

添加新模板

在 lib/templates.js 文件中添加新的模板配置：

{
  name: 'Vue 项目模板',
  value: 'qiuye-vue-template',
  description: '基于 Vue 3 + TypeScript + Vite 的项目模板',
  repo: 'QiuYeDx/qiuye-vue-template',
  branch: 'main'
}

📁 项目结构

qiuye-fe-cli/
├── bin/
│   └── index.js          # 主要的CLI脚本
├── lib/
│   ├── templates.js      # 模板配置
│   └── utils.js          # 工具函数
├── package.json          # 项目配置
└── README.md            # 说明文档

🔧 技术栈

• Commander.js - 命令行接口框架
• Inquirer.js - 交互式命令行用户界面
• Chalk - 终端字符串样式化
• Degit - 轻量级的 git 仓库下载工具
• Ora - 优雅的终端加载动画

📝 环境要求

• Node.js >= 14.0.0
• Git (用于下载模板)

🤝 贡献

欢迎提交 Issue 和 Pull Request！

1. Fork 本仓库
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 创建 Pull Request

📄 许可证

MIT License

🙏 致谢

感谢所有开源项目的贡献者们！

Happy Coding! 🚀