ng-nice / code-front-jet

随书源码:FrontJet前端工具
Apache License 2.0
42 stars 13 forks source link

设计目标

本工具旨在提供一个前端开发工具,提高前端自动化水平,缩短反馈周期。它基于gulp-angular项目改进而来。

改进的首要目的是提供一个可以独立安装的工具,而不用在前端工程下建立node_modules等子目录。其次,建立更完善的规约,以提高自动化水平,利用工具来落实最佳实践。最后,提高集成度,帮助前端初学者更容易的入门,而不用掌握一大堆前端工具。

首次安装

受国内网络环境的影响,部分在国外服务器上的依赖包可能无法正常安装,因此请先用如下命令安装阿里的npm镜像客户端:

npm install -g cnpm --registry=http://registry.npm.taobao.org

装好之后在当前目录下运行install.bat(Windows)或./install(Linux/Mac)即可。

安装过程较长,请耐心等待。如果在安装过程中卡住(命令行窗口长时间没反应),请按ctrl-c中止,然后重新运行install命令。

install命令成功结束后,请尝试运行fj命令,如果安装正常,它会给出一系列帮助信息。

使用

创建新工程

fj create NAME 在当前目录下创建名为NAME的新目录, 其中包含FrontJet工程骨架.

运行开发服务器

进入创建的FrontJet工程, 并运行fj serve命令, 即可在5000端口上启动一个开发服务器. 这个开发服务器会把当前项目下的文件作为静态文件运行起来, 以便可以通过http://localhost:5000访问它. 同时, 它还将启动tdd模式, 当修改任何js文件的时候, 自动重新运行单元测试.

运行端到端(e2e)测试

进入创建的FrontJet工程, 并运行fj e2e命令, 即可尝试运行端到端测试.

构建发布包

进入创建的FrontJet工程, 并运行fj build命令, 即可尝试将当前工程构建为发布包, 构建过程包括了最小化/合并/重命名等, 以求发布一个尽可能小的前端部署包. 它还针对Angular做了特别处理, 以确保 "最小化" 过程不会破坏Angular的依赖注入功能.

运行Mock服务器

进入创建的FrontJet工程, 并运行fj mock命令, 即可尝试将当前工程中的mock子目录作为一个NodeJS服务器运行起来, 它可以在后端被真正实现之前把它模拟出来. 有助于前端和后端彼此独立工作.

查看帮助信息

在任意目录中运行fj help命令即可查看本工具提供的各种命令.