mickey 项目启动与配置教程

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

mickey 项目的目录结构如下所示：

mickey/
├── .gitignore
├── README.md
├── config/
│   └── config.json
├── src/
│   ├── main.py
│   ├── utils/
│   │   └── helper.py
│   └── templates/
│       └── index.html
└── requirements.txt

• README.md：项目的说明文件，包含项目介绍、安装步骤、使用说明等。
• .gitignore：Git 忽略文件列表，用于指定在 Git 版本控制中需要忽略的文件和目录。
• config/：配置文件目录。
  • config.json：项目的配置文件，包含项目运行所需的基础配置信息。
• src/：源代码目录。
  • main.py：项目的入口文件，负责初始化和运行项目。
  • utils/：工具类目录，存放项目所需的辅助函数和工具。
    • helper.py：辅助函数文件，用于存放通用的辅助方法。
  • templates/：模板文件目录，存放 HTML 模板文件。
    • index.html：项目的主页模板文件。
• requirements.txt：项目依赖文件，列出项目运行所需的第三方库。

2. 项目的启动文件介绍

mickey 项目的启动文件为 src/main.py。以下是 main.py 的基本内容和功能：

# 导入必要的库
from flask import Flask, render_template

# 创建 Flask 实例
app = Flask(__name__)

# 定义路由和视图函数
@app.route('/')
def index():
    return render_template('index.html')

# 程序入口
if __name__ == '__main__':
    app.run(debug=True)

main.py 负责初始化 Flask 应用，并定义了项目的路由和视图函数。运行 main.py 文件将启动 Flask 应用。

3. 项目的配置文件介绍

mickey 项目的配置文件为 config/config.json。以下是 config.json 的基本内容：

{
    "app_name": "mickey",
    "port": 5000
}

config.json 文件包含了项目的一些基础配置信息，例如应用名称和运行端口。在 main.py 中可以通过以下方式读取配置：

import json

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

# 使用配置信息
app_name = config["app_name"]
port = config["port"]

通过配置文件，可以方便地管理项目的配置信息，并在需要时进行修改。