egg. JS directory structure

Directory structure

Structural view

egg-project
├── package.json
├── app.js ( Optional )
├── agent.js ( Optional )
├── app（----------- The core ------------）
|   ├── router.js（ route ）
│   ├── controller（ controller ）
│   |   └── home.js
│   ├── service ( Model )
│   |   └── user.js
│   ├── middleware ( middleware )
│   |   └── response_time.js
│   ├── schedule ( Optional )
│   |   └── my_task.js
│   ├── public ( Static resources )
│   |   └── reset.css
│   ├── view ( Template view )
│   |   └── home.tpl
│   └── extend ( Expand )
│       ├── helper.js ( Optional )
│       ├── request.js ( Optional )
│       ├── response.js ( Optional )
│       ├── context.js ( Optional )
│       ├── application.js ( Optional )
│       └── agent.js ( Optional )
├── config
|   ├── plugin.js
|   ├── config.default.js
│   ├── config.prod.js
|   ├── config.test.js ( Optional )
|   ├── config.local.js ( Optional )
|   └── config.unittest.js ( Optional )
└── test
    ├── middleware
    |   └── response_time.test.js
    └── controller
        └── home.test.js

The structure,

Above , The directory agreed by the framework ：

• app/router.js Used for configuration URL Routing rules , Specific see Router.
• app/controller/** Used to parse user input , Return corresponding results after processing , Specific see Controller.
• app/service/** For writing the business logic layer , Optional , It is recommended to use , Specific see Service.
• app/middleware/** For writing middleware , Optional , Specific see Middleware.
• app/public/** Used to place static resources , Optional , See the built-in plug-ins for details egg-static .
• app/extend/** Extension for framework , Optional , Specific see Framework extension .
• config/config.{env}.js For writing configuration files , Specific see To configure .
• config/plugin.js For configuring plug-ins that need to be loaded , Specific see plug-in unit .
• test/** For unit testing , Specific see unit testing .
• app.js and agent.js Used to customize initialization at startup , Optional , Specific see Start customization . About agent.js For more information, see Agent Mechanism .

Directory contracted by built-in plug-ins ：

• app/public/** Used to place static resources , Optional , See the built-in plug-ins for details egg-static .
• app/schedule/** For timed tasks , Optional , Specific see Timing task .

To customize your own directory specification , See Loader API

• app/view/** Used to place template files , Optional , Agreed by the template plug-in , Specific see Template rendering .
• app/model/** For placing domain models , Optional , Agreed by domain class related plug-ins , Such as egg-sequelize .