# Cocoon
Cocoon是集成`angular.js`和`require.js`的前端`MVC`开发框架,通过`require.js`扩展`angular.js`模块按需要加载资源文件。结合`gulp`和`compass`，提高开发流程效率，降低程序维护成本。

### 特性

* 遵循`AMD`规范
* 项目构建命令行工具
* 移动布局处理工具


### 安装

```
$ sudo npm install cocoon-framework -g
$ cocoon --new project-name
```  

### 运行
>
注：cocoon 默认依赖 [compass](http://compass-style.org/) 和 [gulp 4.0](https://github.com/gulpjs/gulp/tree/4.0)。

```
$ cd project-name
$ npm install
$ gulp
```
    


### 目录结构

```bash
├── bower.json
├── build.js
├── config.rb
├── gulpfile.js
├── package.json
└── src
    ├── config.json
    ├── css
    │   ├── home.css
    │   └── layout.css	
    ├── index.html
    ├── sass
    │   ├── _globals.scss 
    │   ├── home.scss
    │   └── layout.scss            
    ├── scripts
    │   ├── app.js 
    │   ├── bootstrap.js  
    │   ├── controllers   
    │   │   └── home.js
    │   ├── directives   
    │   │   └── back.js
    │   ├── layout.js    
    │   ├── services     
    │   │   ├── ajax.js
    │   │   ├── storage.js
    │   │   ├── typing.js
    │   │   └── url.js
    │   └── vendor 
    └── views			
        ├── 404.html
        └── home.html
```

### 配置文件

```bash
└── src
    ├── config.json
```
配置文件中定义包括了路由信息，通过`define(['config'],function(config) { })`读取配置。


### 创建控制器
   

```bash
$ cocoon --create controller user 
$ cocoon --create controller user product
$ cocoon --create controller user/login  user/profile
```
创建控制器的过程中，会同时创建与控制器相绑定的 `html`视图，`scss` 文件和 `css`文件，自动注册路由。


### 创建模型

```bash
$ cocoon --create model user
```

### 创建指令

```bash
$ cocoon --create directive back
```

### 创建服务

```bash
$ cocoon --create service storage
```

### 交流反馈

联系邮箱：[cocoon@lehu.io](mailto:cocoon@lehu.io)

### 协议
Cocoon框架遵循 [MIT](http://opensource.org/licenses/MIT) 开源协议。