GetReceipt-Server 项目使用教程

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

GetReceipt-Server 项目的目录结构如下：

getreceipt-server/
├── config/
│   ├── default.json
│   ├── production.json
│   └── ...
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── index.js
├── tests/
├── .env
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• config/: 存放项目的配置文件，如 default.json 和 production.json。
• src/: 项目的源代码目录，包含控制器、模型、路由和服务等。
  • controllers/: 处理请求逻辑的控制器文件。
  • models/: 数据库模型文件。
  • routes/: 定义API路由的文件。
  • services/: 业务逻辑服务文件。
  • index.js: 项目的入口文件。
• tests/: 存放测试文件。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件负责初始化应用并启动服务器。以下是 index.js 的主要内容：

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

// 中间件配置
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

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

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

启动文件介绍

• 引入必要的模块和配置文件。
• 配置中间件，如 JSON 解析和 URL 编码解析。
• 配置路由，将所有 API 路由挂载到 /api 路径下。
• 启动服务器，监听配置文件中定义的端口（默认为 3000）。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，主要包括 default.json 和 production.json。以下是配置文件的示例内容：

default.json

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "receipt_db"
  },
  "ocr": {
    "apiKey": "your_ocr_api_key"
  }
}

production.json

{
  "port": 8080,
  "database": {
    "host": "production_db_host",
    "port": 27017,
    "name": "production_receipt_db"
  },
  "ocr": {
    "apiKey": "production_ocr_api_key"
  }
}

配置文件介绍

• port: 服务器监听的端口。
• database: 数据库连接配置，包括主机、端口和数据库名称。
• ocr: OCR 服务的 API 密钥配置。

配置文件通过环境变量加载，确保不同环境下的配置分离和安全。