开源项目 `qd-templates` 使用教程

1. 项目的目录结构及介绍

qd-templates/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── index.js
│   ├── controllers/
│   │   ├── homeController.js
│   ├── models/
│   │   ├── userModel.js
│   ├── services/
│   │   ├── userService.js
├── public/
│   ├── index.html
│   ├── css/
│   │   ├── style.css
│   ├── js/
│   │   ├── script.js
├── tests/
│   ├── homeController.test.js

目录结构说明

• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由配置目录。
    • index.js: 路由入口文件。
  • controllers/: 控制器目录。
    • homeController.js: 主页控制器。
  • models/: 数据模型目录。
    • userModel.js: 用户模型。
  • services/: 服务层目录。
    • userService.js: 用户服务。
• public/: 静态资源目录。
  • index.html: 主页HTML文件。
  • css/: CSS样式文件目录。
    • style.css: 主样式文件。
  • js/: JavaScript脚本文件目录。
    • script.js: 主脚本文件。
• tests/: 测试文件目录。
  • homeController.test.js: 主页控制器测试文件。

2. 项目的启动文件介绍

入口文件 src/index.js

const express = require('express');
const app = express();
const config = require('./config');
const routes = require('./routes');

app.use(express.json());
app.use('/', routes);

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

启动文件说明

• 引入 express 框架并创建应用实例。
• 加载配置文件 config。
• 引入并使用路由文件 routes。
• 设置端口并启动服务器。

3. 项目的配置文件介绍

配置文件目录 src/config/

default.json

{
  "port": 3000,
  "db": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "database": "qd_templates"
  }
}

production.json

{
  "port": 8080,
  "db": {
    "host": "production_host",
    "user": "prod_user",
    "password": "prod_password",
    "database": "qd_templates_prod"
  }
}

配置文件说明

• default.json: 默认配置文件，包含开发环境的端口和数据库配置。
• production.json: 生产环境配置文件，包含生产环境的端口和数据库配置。

通过这些配置文件，可以灵活地切换不同环境下的配置，确保项目在不同环境下都能正常运行。