FMI-Unibuc 项目启动与配置教程

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

FMI-Unibuc 项目采用清晰的目录结构，以下是对主要目录的简要介绍：

• src/: 源代码目录，包含项目的主要代码文件。
• docs/: 文档目录，存放项目文档和相关说明。
• tests/: 测试目录，包含所有测试用例和测试脚本。
• data/: 数据目录，用于存放项目运行过程中需要用到的数据文件。
• scripts/: 脚本目录，包含项目运行和部署所需的脚本文件。
• README.md: 项目说明文件，介绍项目的相关信息和使用方法。

2. 项目的启动文件介绍

项目的启动文件通常位于 src/ 目录下，以下是一些常见的启动文件：

• main.py: 主程序文件，项目启动时首先运行的 Python 脚本。
• app.py: 应用程序文件，用于启动 Web 应用程序。
• run.py: 运行脚本，用于执行特定的程序或任务。

启动项目时，通常需要进入 src/ 目录，然后运行相应的启动文件。例如，如果使用 main.py 启动项目，可以在终端中执行以下命令：

python main.py

3. 项目的配置文件介绍

项目的配置文件用于定义项目运行时的参数和设置，通常位于项目的根目录或 config/ 目录下。以下是一些常见的配置文件：

• config.py: Python 格式的配置文件，可以直接在 Python 代码中导入使用。
• config.json: JSON 格式的配置文件，通常用于存储键值对类型的配置信息。
• settings.py: 设置文件，常用于 Web 应用程序中定义各种配置。

配置文件中可能包含数据库连接信息、API 密钥、端口号等敏感信息。因此，在实际部署时，应确保配置文件的安全。

以下是一个简单的 config.py 配置文件示例：

# config.py
DATABASE_URI = 'sqlite:///example.db'
SECRET_KEY = 'your-secret-key'
PORT = 5000

在项目代码中，可以通过导入配置文件来获取配置信息：

import config

database_uri = config.DATABASE_URI
secret_key = config.SECRET_KEY
port = config.PORT

确保在项目部署之前正确配置这些文件，以保证项目的正常运行。