node-framework/wiki/docs/fileStructure.md

node-framework

# 目录结构

## 默认设置
基于node-framework的web应用在默认配置下在根目录__至少__应有如下目录或文件：

* [config](/config)
* [controllers](/controllers)
* log
* [middlewares](/middlewares)
* node_modules
* [public](/public)
* [views](/views)
* index.js
* package.json

其中log是node-framework自身生成的日志文件。node_modules是npm生成的依赖目录，index.js是项目启动器，详见概述中启动段落的相关描述。package.json是npm用以管理依赖的说明文件。  

其它目录/文件会分别进行阐述。您可以点击上面的链接进行查看。

## 用户配置
文件目录的结构除了config之外都是可配置的。如果您需要特殊的文件结构，您可以尝试更改位于`config/global.js`中几个Dir的配置。

```javascript
module.exports = {
    // 当前的运行模式
    debug: true,

    // 指定app的名字
    appname: 'demo',
    // 指定代码根目录
    appdir: './',

    // 版本号
    version: '0.0.0.1',

    // 作者
    author: ['sekiyika'],

    appid: '1',

    appkey: '9d27ebb4-cc4d-488e-91d0-43359d4b31fb',

    staticDir: './public',

    controllerDir: './controllers',

    middlewareDir: './middlewares',

    pluginDir: './plugins',

    templateDir: './views'
};
```