Watched 项目启动与配置教程

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

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

watched/
├── .gitignore
├── Dockerfile
├── README.md
├── app/
│   ├── main.py
│   ├── requirements.txt
│   ├── static/
│   │   └── ...
│   └── templates/
│       └── ...
├── config/
│   └── config.py
└── test/
    └── ...

目录说明：

• .gitignore：Git 忽略文件，用于指定哪些文件和目录不应该被 Git 跟踪。
• Dockerfile：Docker 构建文件，用于创建容器镜像。
• README.md：项目说明文件，包含项目信息、安装和配置指南等。
• app/：项目的主要应用目录，包含项目的源代码。
  • main.py：项目的主入口文件。
  • requirements.txt：项目依赖文件，列出了项目运行所需的 Python 包。
  • static/：静态文件目录，通常包含 CSS、JavaScript 和图片等。
  • templates/：模板文件目录，通常包含 HTML 文件。
• config/：配置文件目录。
  • config.py：项目配置文件，定义了项目的配置信息。
• test/：测试目录，包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py，以下是启动文件的基本内容：

from flask import Flask
from config.config import Config

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

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

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

启动说明：

• 首先，从 flask 模块导入 Flask 类。
• 从 config.config 模块导入 Config 配置类。
• 创建一个 Flask 实例。
• 使用 Config 类来配置 Flask 实例。
• 定义一个路由 /，当访问该路由时，返回 "Hello, World!" 字符串。
• 如果文件作为主程序运行，则启动 Flask 应用。

3. 项目的配置文件介绍

项目的配置文件是 config/config.py，以下是配置文件的基本内容：

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'you-will-never-guess'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///watched.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    ...

配置说明：

• 导入 os 模块，用于获取环境变量。
• 定义一个名为 Config 的类，其中包含项目的配置信息。
• SECRET_KEY 是用于 Flask 应用的安全密钥，通常从环境变量获取，如果没有设置，则使用默认值。
• SQLALCHEMY_DATABASE_URI 是数据库的 URI，同样从环境变量获取，如果没有设置，则使用默认的 SQLite 数据库。
• SQLALCHEMY_TRACK_MODIFICATIONS 设置为 False，用于关闭 SQLALCHEMY 的自动跟踪功能，提高性能。

以上就是 Watched 项目的启动与配置教程，希望对您有所帮助。