Rememory 项目启动与配置教程

1. 项目目录结构及介绍

Rememory 项目的目录结构如下所示：

Rememory/
├── .gitignore
├── .vscode/             # Visual Studio Code 的配置文件
├── bin/                 # 编译后的可执行文件
├── docs/                # 项目文档
├── jwt/                 # JSON Web Token 相关的代码
├── middlewares/         # 中间件目录
├── models/              # 数据模型定义
├── public/              # 公共静态文件，如图片、CSS、JavaScript 等
├── routes/              # 路由处理函数
├── services/            # 业务逻辑处理服务
├── test/                # 测试代码
├── tools/               # 通用工具库
├── app.js               # 主应用程序文件
├── config.js            # 配置文件
├── package.json         # 项目依赖及配置
└── package-lock.json    # 项目依赖的锁定文件

以下是各个目录和文件的简要介绍：

• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• .vscode/: 包含 Visual Studio Code 的项目配置。
• bin/: 存放编译后的可执行文件。
• docs/: 项目文档存放位置。
• jwt/: JSON Web Token 的相关代码。
• middlewares/: 存放项目中使用的中间件。
• models/: 定义数据模型的地方。
• public/: 存放公共静态文件。
• routes/: 定义了应用程序的路由。
• services/: 包含业务逻辑处理的代码。
• test/: 存放单元测试和集成测试代码。
• tools/: 通用工具函数库。
• app.js: 主应用程序文件，是应用程序的启动入口。
• config.js: 项目配置文件。
• package.json: 包含项目的依赖、配置信息和脚本。
• package-lock.json: 确保不同开发环境的依赖项版本一致。

2. 项目的启动文件介绍

项目的启动文件是 app.js，该文件负责初始化和运行整个应用程序。以下是一些关键部分：

const express = require('express');
const app = express();

// 使用中间件
app.use(express.json()); // 解析 JSON 格式的请求体
app.use(express.urlencoded({ extended: true })); // 解析 URL 编码的请求体

// 路由配置
app.use('/api', require('./routes'));

// 错误处理中间件
app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).send('服务器错误!');
});

// 设置端口和启动服务器
const port = process.env.PORT || 3000;
app.listen(port, () => {
  console.log(`服务器运行在 http://localhost:${port}`);
});

这段代码创建了一个 Express 应用程序，配置了必要的中间件，定义了路由，并设置了错误处理中间件。最后，应用程序在指定的端口上启动。

3. 项目的配置文件介绍

项目的配置文件是 config.js，该文件定义了项目中可能需要用到的配置信息，例如数据库连接信息、JWT 密钥等。以下是一个示例：

module.exports = {
  jwtSecret: 'your_jwt_secret',
  db: {
    uri: 'mongodb://localhost:27017/rememory',
    options: {
      useNewUrlParser: true,
      useUnifiedTopology: true,
    },
  },
  port: process.env.PORT || 3000,
};

这个配置文件导出一个对象，其中包含了 JWT 密钥、数据库连接信息以及应用的端口号。这些配置可以在应用的不同部分中使用，以确保配置的一致性和易于管理。