node-framework/wiki/docs/index.md

node-framework

# 概述

## 简介
node-framework是基于nodejs的web应用框架，拥有安装快速便捷，使用简单迅速，功能完整等特点，特别适用于小型且快速迭代项目的搭建。它的特点包括：

* 文件目录简单清晰，框架约束力强，避免项目复杂导致目录结构或者逻辑混乱。
* 控制器(controller)按需加载，编写方式灵活多样。
* 内置监控(monitor)模块，快速掌握web应用的全面信息。
* 中间件(middleware)扩展性强。

## 安装
node-framework的安装和其他node插件类似，使用npm在项目根目录执行：
```bash
$ npm install node-framework
```

## 启动
首先您需要建立一个程序启动入口。一般命名为index.js并放置在项目根目录下。一个示例启动文件如下：
```javascript   
// 项目启动文件index.js
var Application = require('node-framework').Application;
var app = new Application();
app.run();
```
    
线上方式，会调用node cluster启动数个进程，数量等于物理机cpu个数。（可在`config/server.js`的`cluster`配置项进行更改）
```bash       
$ node index.js
```
    
## 目录结构
为了保证项目的功能需求，您还必须满足一定的目录结构并编写控制器、模板页面、前端JS脚本（如果需要的话）等等。[点此查看基本目录结构](/fileStructure)