Node.js 网站模板使用教程

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

Node.js 网站模板（nodejs-website-boilerplate）的目录结构如下：

nodejs-website-boilerplate/
├── config/
│   ├── default.json
│   ├── production.json
│   └── ...
├── public/
│   ├── css/
│   ├── js/
│   └── ...
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── views/
│   └── app.js
├── .env
├── .gitignore
├── package.json
└── README.md

目录介绍：

• config/：包含项目的配置文件，如 default.json 和 production.json。
• public/：存放静态资源文件，如 CSS、JavaScript 文件等。
• src/：项目的源代码目录，包含控制器、模型、路由和视图等。
  • controllers/：处理业务逻辑的控制器文件。
  • models/：数据模型文件。
  • routes/：路由定义文件。
  • views/：视图模板文件。
  • app.js：项目的入口文件。
• .env：环境变量配置文件。
• .gitignore：Git 忽略文件配置。
• package.json：项目的依赖和脚本配置文件。
• README.md：项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/app.js，它是整个应用的入口点。以下是 app.js 的主要内容：

const express = require('express');
const path = require('path');
const bodyParser = require('body-parser');
const config = require('config');

const app = express();

// 设置中间件
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(express.static(path.join(__dirname, 'public')));

// 设置路由
const indexRouter = require('./routes/index');
app.use('/', indexRouter);

// 启动服务器
const port = config.get('port') || 3000;
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件介绍：

• 引入必要的模块：express、path、body-parser 和 config。
• 创建 Express 应用实例：const app = express();。
• 设置中间件：使用 body-parser 处理请求数据，设置静态文件目录。
• 设置路由：引入并使用 indexRouter。
• 启动服务器：从配置文件中获取端口号并启动服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，主要包含 default.json 和 production.json 等文件。

default.json 示例：

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "name": "mydatabase"
  }
}

production.json 示例：

{
  "port": 8080,
  "database": {
    "host": "production-db-host",
    "user": "produser",
    "password": "prodpassword",
    "name": "prod_db"
  }
}

配置文件介绍：

• default.json：默认配置文件，包含开发环境的配置。
• production.json：生产环境的配置文件，会覆盖 default.json 中的相应配置。
• 配置项包括端口号、数据库连接信息等。

通过这些配置文件，可以方便地管理不同环境下的配置，确保应用在不同环境下正常运行。