grest 项目使用教程
1. 项目的目录结构及介绍
grest/
├── README.md
├── app/
│ ├── controllers/
│ ├── models/
│ ├── views/
│ └── routes.js
├── config/
│ ├── default.json
│ ├── production.json
│ └── test.json
├── public/
│ ├── css/
│ ├── js/
│ └── images/
├── server.js
└── package.json
- README.md: 项目说明文件。
- app/: 应用程序的主要目录,包含控制器、模型、视图和路由。
- controllers/: 存放控制器文件。
- models/: 存放模型文件。
- views/: 存放视图文件。
- routes.js: 定义应用程序的路由。
- config/: 配置文件目录,包含不同环境的配置文件。
- default.json: 默认配置文件。
- production.json: 生产环境配置文件。
- test.json: 测试环境配置文件。
- public/: 静态文件目录,包含CSS、JavaScript和图片文件。
- css/: 存放CSS文件。
- js/: 存放JavaScript文件。
- images/: 存放图片文件。
- server.js: 项目的启动文件。
- package.json: 项目的依赖管理文件。
2. 项目的启动文件介绍
server.js
是项目的启动文件,负责启动服务器和加载应用程序。以下是 server.js
的主要内容:
const express = require('express');
const app = express();
const config = require('./config/default.json');
// 加载路由
require('./app/routes')(app);
// 启动服务器
const port = process.env.PORT || config.port;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
- 引入依赖: 引入
express
和其他必要的模块。 - 加载配置: 从
config
目录中加载配置文件。 - 加载路由: 加载应用程序的路由。
- 启动服务器: 根据配置文件中的端口启动服务器。
3. 项目的配置文件介绍
config
目录包含不同环境的配置文件,以下是 default.json
的内容示例:
{
"port": 3000,
"database": {
"host": "localhost",
"user": "root",
"password": "",
"dbname": "grest"
}
}
- port: 服务器监听的端口。
- database: 数据库配置,包括主机、用户名、密码和数据库名。
其他配置文件如 production.json
和 test.json
可以根据不同环境的需求进行相应的配置。