Vendo 开源项目使用教程

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

Vendo 项目的目录结构如下：

vendo/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   ├── routes/
│   └── index.js
├── config/
│   ├── default.json
│   ├── production.json
│   └── test.json
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── package.json
└── server.js

目录结构介绍

• app/: 包含应用程序的主要代码。
  • controllers/: 存放控制器文件。
  • models/: 存放模型文件。
  • views/: 存放视图文件。
  • routes/: 存放路由文件。
  • index.js: 应用程序的入口文件。
• config/: 包含配置文件。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
  • test.json: 测试环境配置文件。
• public/: 存放静态资源文件，如 CSS、JavaScript 和图片。
• package.json: 项目的依赖和脚本配置文件。
• server.js: 服务器的启动文件。

2. 项目的启动文件介绍

项目的启动文件是 server.js。该文件负责启动服务器并加载应用程序的主要模块。

server.js 内容概览

const express = require('express');
const app = express();
const port = process.env.PORT || 3000;

app.use(express.static('public'));
app.use('/', require('./app/routes'));

app.listen(port, () => {
  console.log(`Server running on port ${port}`);
});

启动文件功能

• 引入 Express 框架。
• 设置静态文件目录为 public/。
• 加载路由模块。
• 监听指定端口（默认为 3000）并启动服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包含以下文件：

• default.json: 默认配置文件。
• production.json: 生产环境配置文件。
• test.json: 测试环境配置文件。

配置文件内容示例

default.json

{
  "app": {
    "name": "Vendo",
    "version": "1.0.0"
  },
  "server": {
    "port": 3000
  },
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "vendo_db"
  }
}

production.json

{
  "server": {
    "port": 8080
  },
  "database": {
    "host": "prod-db-host",
    "port": 27017,
    "name": "vendo_prod_db"
  }
}

test.json

{
  "server": {
    "port": 3001
  },
  "database": {
    "host": "test-db-host",
    "port": 27017,
    "name": "vendo_test_db"
  }
}

配置文件功能

• default.json: 包含默认的配置选项，如应用程序名称、版本、服务器端口和数据库连接信息。
• production.json: 覆盖默认配置，提供生产环境的特定设置。
• test.json: 覆盖默认配置，提供测试环境的特定设置。

通过这些配置文件，可以轻松管理不同环境下的应用程序设置。