AZ Insurance 开源项目教程
1. 项目的目录结构及介绍
az-insurance/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── routes/
│ │ ├── api.js
│ ├── models/
│ │ ├── User.js
│ ├── controllers/
│ │ ├── userController.js
│ ├── utils/
│ │ ├── helper.js
- README.md: 项目说明文件。
- package.json: 项目依赖和脚本配置文件。
- src/: 源代码目录。
- index.js: 项目入口文件。
- config/: 配置文件目录。
- default.json: 默认配置文件。
- production.json: 生产环境配置文件。
- routes/: 路由文件目录。
- api.js: API 路由文件。
- models/: 数据模型文件目录。
- User.js: 用户模型文件。
- controllers/: 控制器文件目录。
- userController.js: 用户控制器文件。
- utils/: 工具函数文件目录。
- helper.js: 辅助函数文件。
2. 项目的启动文件介绍
index.js 是项目的入口文件,负责启动应用。以下是 index.js
的主要内容:
const express = require('express');
const app = express();
const config = require('./config/default.json');
app.use(express.json());
app.use('/api', require('./routes/api'));
const PORT = process.env.PORT || config.port;
app.listen(PORT, () => {
console.log(`Server running on port ${PORT}`);
});
- 引入
express
模块并创建应用实例。 - 加载配置文件
default.json
。 - 使用
express.json()
中间件处理 JSON 请求。 - 挂载
/api
路由。 - 监听指定端口启动服务器。
3. 项目的配置文件介绍
config/ 目录下包含项目的配置文件,主要有 default.json
和 production.json
。
default.json:
{
"port": 3000,
"database": {
"host": "localhost",
"user": "root",
"password": "",
"database": "az_insurance"
}
}
- port: 服务器监听的端口。
- database: 数据库连接配置。
production.json:
{
"port": 8080,
"database": {
"host": "production_host",
"user": "production_user",
"password": "production_password",
"database": "az_insurance_prod"
}
}
- port: 生产环境服务器监听的端口。
- database: 生产环境数据库连接配置。
这些配置文件通过环境变量加载,确保不同环境下的配置分离。