开源项目 lightbug_http 使用教程
1. 项目的目录结构及介绍
lightbug_http/
├── README.md
├── app/
│ ├── controllers/
│ ├── models/
│ ├── views/
├── config/
│ ├── config.json
│ ├── routes.json
├── public/
│ ├── css/
│ ├── js/
├── server.js
- README.md: 项目说明文件。
- app/: 应用程序的主要目录,包含控制器、模型和视图。
- controllers/: 存放控制器文件。
- models/: 存放模型文件。
- views/: 存放视图文件。
- config/: 配置文件目录。
- config.json: 主配置文件。
- routes.json: 路由配置文件。
- public/: 静态文件目录,包含CSS和JavaScript文件。
- css/: 存放CSS文件。
- js/: 存放JavaScript文件。
- server.js: 项目的启动文件。
2. 项目的启动文件介绍
server.js 是项目的启动文件,负责启动服务器并加载必要的配置。以下是 server.js
的主要内容:
const express = require('express');
const app = express();
const config = require('./config/config.json');
app.use(express.static('public'));
require('./config/routes')(app);
app.listen(config.port, () => {
console.log(`Server is running on port ${config.port}`);
});
- 引入
express
模块并创建应用实例。 - 加载配置文件
config.json
。 - 设置静态文件目录为
public/
。 - 加载路由配置。
- 启动服务器并监听配置文件中指定的端口。
3. 项目的配置文件介绍
config.json 是项目的主配置文件,包含端口和其他全局配置。以下是 config.json
的内容示例:
{
"port": 3000,
"database": {
"host": "localhost",
"user": "root",
"password": "123456",
"database": "lightbug_http"
}
}
- port: 服务器监听的端口。
- database: 数据库连接配置,包括主机、用户名、密码和数据库名。
routes.json 是路由配置文件,定义了URL路径和对应的控制器方法。以下是 routes.json
的内容示例:
{
"/": "HomeController.index",
"/about": "AboutController.index",
"/contact": "ContactController.index"
}
- 定义了不同URL路径对应的控制器和方法。例如,
/
路径对应HomeController
的index
方法。