WikiSpeedrun 项目启动与配置教程

1. 项目目录结构及介绍

WikiSpeedrun 项目的目录结构如下：

WikiSpeedrun/
├── .gitignore            # 忽略文件列表
├── .travis.yml           # Travis CI 持续集成配置文件
├── Dockerfile            # Docker 镜像构建文件
├── README.md             # 项目说明文件
├── setup.py              # 项目安装和依赖配置文件
├── requirements.txt      # 项目依赖文件
├── wiki-speedrun/        # 项目主目录
│   ├── __init__.py       # 初始化文件
│   ├── app.py            # 主应用程序文件
│   ├── config.py         # 配置文件
│   ├── models.py         # 数据模型文件
│   ├── static/           # 静态文件目录
│   │   └── ...
│   ├── templates/        # 模板文件目录
│   │   └── ...
│   └── utils/            # 工具类文件目录
│       └── ...
└── ...

主要目录和文件介绍：

• .gitignore: 指定在 Git 仓库中应当忽略的文件和目录。
• .travis.yml: 用于配置 Travis CI 持续集成服务。
• Dockerfile: 用于构建项目的 Docker 镜像。
• README.md: 项目说明文件，包含了项目的介绍、安装和使用说明。
• setup.py: Python 项目安装和依赖配置文件。
• requirements.txt: 包含了项目运行所依赖的 Python 包。
• wiki-speedrun: 项目主目录，包含了项目的核心代码和资源。
  • __init__.py: 初始化文件，通常为空文件，用于标识目录为 Python 包。
  • app.py: 主应用程序文件，包含了应用程序的启动和运行逻辑。
  • config.py: 配置文件，包含了项目运行所需的各种配置信息。
  • models.py: 数据模型文件，定义了项目中使用的数据模型。
  • static/: 静态文件目录，包含了 CSS、JavaScript 和图片等静态资源。
  • templates/: 模板文件目录，包含了项目使用的 HTML 模板。
  • utils/: 工具类文件目录，包含了项目中使用的工具类。

2. 项目的启动文件介绍

项目的启动文件为 wiki-speedrun/app.py。以下是启动文件的基本内容：

from flask import Flask
from config import Config

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

@app.route('/')
def index():
    return 'Hello, WikiSpeedrun!'

if __name__ == '__main__':
    app.run()

启动文件功能说明：

• 导入 Flask 和 Config 类。
• 创建 Flask 应用实例。
• 加载配置信息。
• 定义路由和视图函数，例如上述的根路由 /。
• 如果文件作为主程序运行，则启动 Flask 应用。

3. 项目的配置文件介绍

项目的配置文件为 wiki-speedrun/config.py。以下是配置文件的基本内容：

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'a-very-secret-key'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///wiki-speedrun.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

配置文件功能说明：

• 设置了 Flask 应用的配置信息，如密钥和数据库 URI。
• 使用环境变量来获取配置值，如果没有设置环境变量，则使用默认值。
• SQLALCHEMY_TRACK_MODIFICATIONS 设置为 False，以避免不必要的 SQLAlchemy 跟踪通知。