ToS;DR 项目使用教程

2024-09-15 17:13:44作者：钟日瑜

1. 项目目录结构及介绍

ToS;DR 项目的目录结构如下：

tosdr.org/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── ...
├── config/
│   ├── database.js
│   ├── environment.js
│   └── ...
├── public/
│   ├── css/
│   ├── js/
│   ├── images/
│   └── ...
├── routes/
│   ├── index.js
│   └── ...
├── test/
│   ├── unit/
│   ├── integration/
│   └── ...
├── .env
├── .gitignore
├── package.json
├── README.md
└── server.js

目录介绍

app/: 包含应用程序的主要代码，包括控制器、模型和视图。
- controllers/: 处理请求和响应的逻辑。
- models/: 数据库模型定义。
- views/: 前端视图模板。
config/: 包含项目的配置文件，如数据库配置、环境配置等。
public/: 静态文件目录，包含CSS、JavaScript、图片等资源。
routes/: 定义应用程序的路由。
test/: 包含单元测试和集成测试的代码。
.env: 环境变量配置文件。
.gitignore: Git忽略文件列表。
package.json: 项目依赖和脚本配置。
README.md: 项目说明文档。
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(express.json());

// 加载路由
const routes = require('./routes/index');
app.use('/', routes);

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

启动文件功能

引入Express: 使用Express框架来创建服务器。
配置中间件: 设置静态文件目录和JSON解析中间件。
加载路由: 加载应用程序的路由配置。
启动服务器: 监听指定端口，启动服务器。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，其中最重要的配置文件是 database.js 和 environment.js。

database.js

// config/database.js
module.exports = {
  development: {
    username: process.env.DB_USERNAME,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    host: process.env.DB_HOST,
    dialect: 'mysql',
  },
  production: {
    username: process.env.DB_USERNAME,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    host: process.env.DB_HOST,
    dialect: 'mysql',
  },
};

environment.js

// config/environment.js
module.exports = {
  development: {
    apiUrl: 'http://localhost:3000',
    debug: true,
  },
  production: {
    apiUrl: 'https://tosdr.org',
    debug: false,
  },
};