Buildfy-Free 项目启动与配置教程

1. 项目目录结构及介绍

Buildfy-Free 项目的目录结构如下：

Buildfy-Free/
├── .env.example             # 环境变量示例文件
├── .gitignore               # Git 忽略文件
├── Dockerfile              # Docker 镜像构建文件
├── README.md               # 项目说明文件
├── app/                     # 应用程序目录
│   ├── __init__.py
│   ├── main/                # 主程序目录
│   │   ├── __init__.py
│   │   ├── config.py        # 配置文件
│   │   ├── models.py        # 数据模型文件
│   │   ├── routes.py        # 路由配置文件
│   │   └── views.py         # 视图文件
│   └── utils/               # 工具类目录
│       ├── __init__.py
│       └── logger.py        # 日志工具
├── bin/                     # 脚本目录
│   └── run.py               # 项目启动脚本
├── migrations/              # 数据库迁移目录
├── requirements.txt         # 项目依赖文件
└── tests/                   # 测试目录

目录说明：

• .env.example: 环境变量示例文件，用于展示项目可能需要的环境变量。
• .gitignore: Git 忽略文件，指定 Git 应该忽略的文件和目录。
• Dockerfile: Docker 镜像构建文件，用于构建项目的 Docker 容器。
• README.md: 项目说明文件，介绍项目的相关信息。
• app/: 应用程序目录，包含项目的核心代码。
• bin/: 脚本目录，包含项目启动和其他相关脚本。
• migrations/: 数据库迁移目录，用于数据库版本控制。
• requirements.txt: 项目依赖文件，列出项目所需的第三方库。
• tests/: 测试目录，包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 bin/run.py，该脚本用于启动应用程序。以下是启动文件的简要介绍：

# bin/run.py
from app import create_app

app = create_app()

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

启动文件说明：

• 导入 create_app 函数，该函数位于 app/__init__.py 文件中，用于创建应用程序实例。
• 创建应用程序实例 app。
• 如果该脚本作为主程序运行，则通过 app.run() 启动应用程序。

3. 项目的配置文件介绍

项目的配置文件位于 app/main/config.py，该文件用于定义项目所需的配置信息。以下是配置文件的简要介绍：

# app/main/config.py
import os

class Config:
    """配置基类"""
    SECRET_KEY = os.getenv('SECRET_KEY', 'default_secret_key')
    SQLALCHEMY_DATABASE_URI = os.getenv('DATABASE_URL', 'sqlite:///default.db')
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    # 其他配置项...

# 可以定义其他配置类，如开发环境、测试环境和生产环境配置

配置文件说明：

• 使用 os.getenv 函数从环境变量获取配置值，如果环境变量不存在，则使用默认值。
• 定义了 SECRET_KEY 和 SQLALCHEMY_DATABASE_URI 等关键配置项。
• 可以根据不同的运行环境定义不同的配置类，例如 DevelopmentConfig、TestingConfig 和 ProductionConfig。