Hyrule-Compendium-API 项目启动与配置教程

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

Hyrule-Compendium-API 项目采用了清晰的目录结构，以下是项目的主要目录及其功能介绍：

• docs: 存放项目文档和相关说明。
• src: 源代码目录，包含项目的所有代码。
  • main.py: 项目的入口文件。
  • config.py: 配置文件，用于存放项目配置。
  • models.py: 定义数据模型。
  • routes.py: 定义路由和视图函数。
  • utils.py: 存放一些工具类和函数。
• tests: 测试代码目录。
• venv: 虚拟环境目录，用于存放项目依赖的Python包。
• requirements.txt: 项目依赖的Python包列表。
• .gitignore: 指定Git应该忽略的文件和目录。

2. 项目的启动文件介绍

项目的启动文件为 src/main.py。以下是启动文件的简要介绍：

from flask import Flask
from config import Config
from routes import setup_routes

app = Flask(__name__)
app.config.from_object(Config)

# 设置路由
setup_routes(app)

if __name__ == "__main__":
    app.run(debug=True)

该文件首先从 flask 库导入 Flask 类，然后从 config 模块导入 Config 类，用于配置项目。接着从 routes 模块导入 setup_routes 函数，该函数用于设置路由。在 app 实例中加载配置后，调用 setup_routes 函数设置路由。最后，如果该文件是作为主程序运行，则启动 Flask 应用程序。

3. 项目的配置文件介绍

项目的配置文件为 src/config.py。以下是配置文件的简要介绍：

import os

class Config:
    # 数据库配置
    SQLALCHEMY_DATABASE_URI = 'sqlite:///hyrule_compendium.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

    # Flask 应用配置
    SECRET_KEY = os.urandom(24)

    # 其他配置项
    # ...

配置文件中定义了一个 Config 类，其中包含项目所需的各种配置项。例如，数据库配置 SQLALCHEMY_DATABASE_URI 和 SQLALCHEMY_TRACK_MODIFICATIONS，以及 Flask 应用的密钥 SECRET_KEY。这些配置项可以根据实际需求进行调整。在 main.py 中，通过 app.config.from_object(Config) 将这些配置加载到 Flask 应用实例中。