CherryMX 项目启动与配置教程

1. 项目目录结构及介绍

CherryMX 项目目录结构如下：

CherryMX/
├── .gitignore
├── README.md
├── requirements.txt
├── cherryMX/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── __init__.py
│   │   └── helper.py
│   └── templates/
│       └── index.html
└── tests/
    ├── __init__.py
    └── test_main.py

• .gitignore：指定 Git 忽略的文件和目录。
• README.md：项目说明文件。
• requirements.txt：项目依赖的 Python 包列表。
• cherryMX/：项目核心代码目录。
  • __init__.py：Python 包初始化文件。
  • main.py：项目启动文件，用于启动应用程序。
  • config.py：项目配置文件，用于存储配置信息。
  • utils/：工具模块目录。
    • __init__.py：Python 包初始化文件。
    • helper.py：辅助功能模块。
  • templates/：HTML 模板文件目录。
    • index.html：主页模板文件。
• tests/：项目测试代码目录。
  • __init__.py：Python 包初始化文件。
  • test_main.py：测试 main.py 的代码。

2. 项目的启动文件介绍

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

from config import Config
from flask import Flask

app = Flask(__name__)
config = Config()

@app.route('/')
def index():
    return app.send_static_file('index.html')

if __name__ == '__main__':
    app.run(debug=config.DEBUG)

• from config import Config：导入配置文件模块，用于获取配置信息。
• from flask import Flask：导入 Flask 类，用于创建 Web 应用程序。
• app = Flask(__name__)：创建 Flask 实例。
• config = Config()：创建配置实例，用于获取配置信息。
• @app.route('/')：定义路由，访问根地址 (/) 时触发 index 函数。
• def index()：定义处理函数，返回静态文件 index.html。
• if __name__ == '__main__':：判断是否为主程序，如果是，则运行以下代码。
• app.run(debug=config.DEBUG)：启动 Flask 应用程序，并根据配置文件中的 DEBUG 选项开启或关闭调试模式。

3. 项目的配置文件介绍

项目的配置文件为 cherryMX/config.py，其主要功能如下：

import os

class Config:
    DEBUG = True
    SECRET_KEY = os.urandom(24)
    STATIC_FOLDER = 'static'
    TEMPLATE_FOLDER = 'templates'

• import os：导入 os 模块，用于生成随机密钥。
• class Config:：定义配置类。
• DEBUG = True：开启调试模式。
• SECRET_KEY = os.urandom(24)：生成随机密钥，用于 Flask 会话管理。
• STATIC_FOLDER = 'static'：静态文件目录。
• TEMPLATE_FOLDER = 'templates'：模板文件目录。