AngularFun 项目技术文档

1. 安装指南

在开始使用 AngularFun 项目之前，您需要安装以下一次性依赖项：

• Git
• Node.js
• Grunt：在终端使用以下命令安装

  $ npm install -g grunt-cli
  

• karma：对于 Windows 系统，您可能需要全局安装 karma。使用以下终端命令：

  $ npm install -g karma
  

在安装完这些依赖项之后，请在终端执行以下命令：

$ git clone [e-mail]:CaryLandholt/AngularFun.git
$ cd AngularFun
$ npm install

2. 项目的使用说明

AngularFun 项目是一个基于 AngularJS 的大型应用程序参考架构。它提供了创建自己的 AngularJS 应用程序的基础，并且减少了样板代码和仪式。

遵循项目提供的模式，您将获得一个完整的开发工作流程，包括：

• 文件组织
• CoffeeScript 文件的转译（如果您更喜欢纯 JavaScript，请参见 JS Love）
• LESS 文件的转译
• Jade 文件的转译
• 通过 Bower 获取的包
• 三种构建配置
  • build：无优化编译
  • default 或 dev：无优化编译，但包括文件监控以实时编译更改的文件
  • prod：带所有优化的编译，包括合并和压缩 png、JavaScript、CSS 和 HTML 文件
• 完整的依赖管理（文件加载和依赖解析）
• 单元测试策略
• 用于运行应用程序的服务器

3. 项目API使用文档

本项目API使用文档部分省略，具体API使用请参照项目内相关说明和代码。

4. 项目安装方式

安装

在终端执行以下命令来克隆和安装 AngularFun 项目：

$ git clone [e-mail]:CaryLandholt/AngularFun.git
$ cd AngularFun
$ npm install

编译

您可以选择以下几种编译方式：

1. grunt build：将应用编译为单独的文件（运行时，文件将按需加载）
2. grunt 或 grunt dev：与 grunt build 相同，但会启动应用，监视文件变化，实时重新编译更改的文件，并重新加载浏览器
3. grunt prod：使用优化进行编译。这将创建一个 JavaScript 文件和一个 CSS 文件，以演示 r.js（ RequireJS 的构建优化工具）的功能。查看 index.html 文件，是的，它也被压缩了
4. grunt test：编译应用并运行所有单元测试

运行

1. 使用上述三种方式之一编译应用。grunt 和 grunt dev 将自动运行 Web 服务器并在默认浏览器中打开应用。
2. grunt serve 或 grunt server：将运行 Web 服务器并在默认浏览器中打开应用。

更改

使用 grunt 或 grunt dev 时，将监视任何 .coffee、.less、.jade 或 .html 文件的变化。检测到更改时，将进行语法检查、编译，并准备好在浏览器中刷新。

测试

使用 grunt test 命令运行单元测试，它将使用 Karma 测试运行器进行测试。