P1finger 项目启动与配置教程

1. 项目目录结构及介绍

P1finger 项目目录结构如下所示：

P1finger/
├── .gitignore       # Git 忽略文件配置
├── Dockerfile       # Docker 镜像构建文件
├── LICENSE          # 项目许可证文件
├── README.md        # 项目说明文件
├── config/          # 配置文件目录
│   └── config.json  # 配置文件
├── docs/            # 文档目录
│   └── ...
├── requirements.txt # 项目依赖文件
├── run.py           # 项目启动文件
└── src/             # 源代码目录
    ├── ...
    └── ...

• .gitignore: 指定 Git 应该忽略的文件和目录。
• Dockerfile: 用于构建项目的 Docker 镜像。
• LICENSE: 项目使用的开源许可证。
• README.md: 项目的基本介绍和说明。
• config/: 存放项目的配置文件。
  • config.json: 包含项目运行所需的基本配置信息。
• docs/: 存放项目文档。
• requirements.txt: 列出项目依赖的 Python 包。
• run.py: 项目的主启动文件。
• src/: 存放项目的源代码。

2. 项目的启动文件介绍

项目的启动文件为 run.py。该文件是项目的入口点，其主要功能是初始化并运行项目。以下是一个简化的 run.py 文件示例：

import json
from src import app

# 读取配置文件
with open('config/config.json', 'r') as config_file:
    config = json.load(config_file)

# 配置并启动应用
if __name__ == '__main__':
    app.run(
        host=config.get('host'),
        port=config.get('port'),
        debug=config.get('debug')
    )

该文件首先导入了所需的模块和配置文件，然后在主函数中读取配置文件，并根据配置文件中的信息启动应用。

3. 项目的配置文件介绍

项目的配置文件为 config/config.json，它是一个 JSON 格式的文件，包含了项目运行时需要的一些基本配置信息。以下是一个配置文件的示例：

{
    "host": "0.0.0.0",
    "port": 5000,
    "debug": true
}

在这个配置文件中：

• host: 指定了应用监听的主机地址。
• port: 指定了应用监听的端口号。
• debug: 指定了是否开启调试模式。

配置文件中的这些信息可以在 run.py 中被读取并用于配置和启动应用。