Brunch 项目技术文档

1. 安装指南

1.1 安装 Node.js

在安装 Brunch 之前，请确保你已经安装了 Node.js。你可以通过以下命令检查是否已安装 Node.js：

node -v

如果没有安装，请访问 Node.js 官网 下载并安装适合你操作系统的版本。

1.2 安装 Brunch

使用 npm 全局安装 Brunch：

npm install -g brunch

安装完成后，你可以通过以下命令检查 Brunch 是否安装成功：

brunch -v

2. 项目的使用说明

2.1 创建新项目

使用 Brunch 创建一个新的项目，可以通过以下命令：

brunch new [--skeleton url]

--skeleton 选项允许你指定一个模板（skeleton），从该模板初始化你的应用程序。默认模板（dead-simple）不包含任何框架或库的偏好。

2.2 开发模式

在开发过程中，你可以使用以下命令启动 Brunch 的开发服务器：

brunch watch --server

该命令会监视你的项目文件，并在文件发生变化时自动增量构建项目。--server 选项会启动一个简单的 Web 服务器，支持 push state。

2.3 部署项目

当你准备部署项目时，可以使用以下命令构建生产环境的代码：

brunch build --production

该命令会生成一个用于发布的项目版本，默认情况下会启用代码压缩。

3. 项目API使用文档

3.1 常用命令

• brunch new [--skeleton url]：创建新项目。
• brunch watch --server：启动开发服务器并监视文件变化。
• brunch build --production：构建生产环境的代码。

3.2 调试模式

如果你想启用调试模式，可以在任何命令后添加 -d 标志：

brunch build -d

3.3 自定义插件

如果你想创建自己的 Brunch 插件，可以使用 Brunch 提供的插件模板作为起点：

brunch new --skeleton https://github.com/brunch/brunch-boilerplate-plugin

4. 项目安装方式

4.1 通过 npm 安装

使用 npm 全局安装 Brunch：

npm install -g brunch

4.2 安装最新版本

如果你想安装 Brunch 的最新开发版本（来自 GitHub 的 master 分支），可以使用以下命令：

npm install -g brunch/brunch

通过以上步骤，你可以顺利安装并使用 Brunch 进行前端 Web 应用的开发和部署。