TShop 开源项目使用教程

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

TShop 项目的目录结构如下：

TShop/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
├── config/
├── public/
│   ├── css/
│   ├── js/
├── routes/
├── tests/
├── .env
├── .gitignore
├── package.json
├── README.md

目录结构介绍

• app/: 包含应用程序的主要代码，分为 controllers、models 和 views 三个子目录。
  • controllers/: 存放控制器文件，处理用户请求。
  • models/: 存放数据模型文件，处理数据逻辑。
  • views/: 存放视图文件，负责前端展示。
• config/: 存放配置文件，如数据库配置、环境配置等。
• public/: 存放静态资源文件，如 CSS、JavaScript 文件等。
• routes/: 存放路由文件，定义 URL 和处理函数的映射关系。
• tests/: 存放测试文件，用于自动化测试。
• .env: 环境变量文件，存储敏感信息和配置。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

TShop 项目的启动文件是 app.js，位于项目根目录下。该文件负责初始化应用程序，加载配置文件，启动服务器等。

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

// 加载路由
require('./routes')(app);

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

启动文件介绍

• 引入 express 模块，创建 app 实例。
• 加载配置文件 config。
• 加载路由文件，定义 URL 和处理函数的映射关系。
• 启动服务器，监听指定端口。

3. 项目的配置文件介绍

TShop 项目的配置文件主要位于 config/ 目录下，包括数据库配置、环境配置等。

配置文件介绍

• config/default.json: 默认配置文件，包含通用配置项。
• config/production.json: 生产环境配置文件，包含生产环境特有的配置项。
• config/development.json: 开发环境配置文件，包含开发环境特有的配置项。

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

配置文件介绍

• port: 服务器监听的端口号。
• database: 数据库配置，包括主机地址、用户名、密码和数据库名。

通过以上配置文件，可以根据不同的环境（开发、测试、生产）加载不同的配置项，实现灵活的配置管理。