Pro-CLI 项目结构快速生成的脚手架-ylab

一个强大的命令行工具，用于快速生成各种主流框架的项目结构，支持 Express.js、Flask、FastAPI、Spring Boot 等多种框架。

✨ 功能特性

• 🚀 快速生成: 一键生成完整的项目结构
• 🎯 多框架支持: 支持 Express.js、Flask、FastAPI、Spring Boot
• 📋 交互式选择: 友好的命令行交互界面
• 📁 完整结构: 自动创建目录结构和配置文件
• 📝 项目模版注册: 使用命令行交互可以快速将当前目录下的文件注册为复用模版。
• 🔧 开箱即用: 生成的项目包含完整的配置和示例代码

🎯 支持的框架

| 框架 | 语言 | 描述 | |------|------|------| | Express.js | JavaScript | Node.js web 框架 | | Flask | Python | 轻量级 Python web 框架 | | FastAPI | Python | 现代高性能 Python web 框架 | | Spring Boot | Java | 企业级 Java 应用框架 |

📦 安装

先决条件

• Node.js 版本 13+
• npm 或 yarn

安装依赖

npm install

🚀 使用方法

启动脚手架

npm run pro-cli

操作流程

1. 选择操作类型

   • 创建新项目
   • 查看已注册项目

2. 选择框架类型

   • Express.js (Node.js)
   • Flask (Python)
   • FastAPI (Python)
   • Spring Boot (Java)

3. 输入项目名称

   • 输入您的项目名称

4. 自动生成项目

   • 脚手架将自动创建项目结构
   • 生成配置文件和示例代码
   • 注册项目信息

📁 生成的项目结构

Express.js 项目

my-express-app/
├── package.json          # 项目配置和依赖
├── app.js                # 主应用文件
├── .env                  # 环境变量
├── README.md             # 项目说明
├── routes/               # 路由目录
├── middleware/           # 中间件目录
├── models/               # 数据模型目录
├── controllers/          # 控制器目录
├── public/               # 静态文件目录
└── views/                # 视图模板目录

FastAPI 项目

my-fastapi-app/
├── main.py               # 主应用文件
├── requirements.txt      # Python 依赖
├── .env                  # 环境变量
├── README.md             # 项目说明
├── routers/              # 路由目录
├── models/               # 数据模型目录
├── schemas/              # Pydantic 模式目录
├── services/             # 业务逻辑目录
└── utils/                # 工具函数目录

Spring Boot 项目

my-spring-app/
├── pom.xml               # Maven 配置
├── README.md             # 项目说明
└── src/
    ├── main/
    │   ├── java/com/example/
    │   │   ├── Application.java
    │   │   └── controller/
    │   └── resources/
    │       └── application.properties
    └── test/
        └── java/com/example/

🔧 核心依赖

• prompts: 提供交互式命令行界面
• path: Node.js 原生路径操作模块
• fs: Node.js 原生文件系统模块

📝 项目注册功能

脚手架会自动记录生成的项目信息，包括：

• 项目名称
• 使用的框架
• 编程语言
• 项目路径
• 创建时间

可以通过选择"查看已注册项目"来查看所有生成的项目列表。

🎮 快速开始示例

创建 Express.js 项目

npm run pro-cli
# 选择: 创建新项目
# 选择: Express.js (Node.js)
# 输入: my-express-app
cd my-express-app
npm install
npm start

创建 FastAPI 项目

npm run pro-cli
# 选择: 创建新项目
# 选择: FastAPI (Python)
# 输入: my-fastapi-app
cd my-fastapi-app
pip install -r requirements.txt
python main.py

🤝 贡献

欢迎提交 Issue 和 Pull Request 来改进这个项目！

📄 许可证

MIT License

👨‍💻 作者

ylab

https://registry.npmmirror.com/