Qemantra 项目启动与配置教程

1. 项目目录结构及介绍

Qemantra 项目的目录结构如下：

qemantra/
├── .gitignore
├── Dockerfile
├── README.md
├── config
│   └── config.json
├── docs
│   └── ...
├── scripts
│   └── ...
├── src
│   ├── main.py
│   ├── ...
│   └── ...
└── tests
    └── ...

• .gitignore：指定 Git 忽略跟踪的文件和目录。
• Dockerfile：用于构建 Docker 容器的配置文件。
• README.md：项目的说明文档，包含项目的基本信息和安装使用指南。
• config：存放项目配置文件的目录。
  • config.json：项目的配置文件，包含数据库连接、API 密钥等配置信息。
• docs：存放项目文档的目录。
• scripts：存放项目脚本文件的目录，如数据迁移、初始化脚本等。
• src：项目的核心代码目录。
  • main.py：项目的主启动文件。
• tests：存放项目测试文件的目录。

2. 项目的启动文件介绍

项目的启动文件为 src/main.py，其主要功能如下：

• 初始化项目所依赖的各种资源。
• 配置日志。
• 设置数据库连接。
• 加载配置文件。
• 启动服务器。

以下是 main.py 的简化示例：

import uvicorn

if __name__ == "__main__":
    uvicorn.run("main:app", host="0.0.0.0", port=8000, log_level="info")

3. 项目的配置文件介绍

项目的配置文件为 config/config.json，其中包含项目运行所需的配置信息。以下是配置文件的一个示例：

{
    "database": {
        "host": "localhost",
        "port": 3306,
        "user": "root",
        "password": "password",
        "name": "qemantra"
    },
    "api_keys": {
        "service_1": "API_KEY_1",
        "service_2": "API_KEY_2"
    }
}

在此配置文件中，定义了数据库连接信息，包括主机地址、端口、用户名、密码和数据库名称。同时，还包含了用于调用外部服务的 API 密钥。

在项目启动时，应确保正确配置这些信息以确保项目正常运行。