CLsurvey 项目启动与配置教程

1. 项目目录结构及介绍

CLsurvey 项目是一个开源项目，其目录结构如下：

CLsurvey/
├── .gitignore          # Git 忽略文件
├── .env.example        # 环境变量示例文件
├── Dockerfile          # Docker 构建文件
├── README.md           # 项目说明文件
├── LICENSE             # 开源许可证文件
├── config/             # 配置文件目录
│   ├── base.py         # 基础配置文件
│   └── local.py        # 本地开发环境配置文件
├── manage.py           # 管理脚本，用于启动项目
├── requirements.txt    # 项目依赖的 Python 包列表
├── run.py              # 项目启动文件
├── survey/             # 调查问卷模块目录
│   ├── __init__.py     # 初始化文件
│   ├── models.py       # 数据模型文件
│   ├── views.py        # 视图处理文件
│   └── templates/      # 模板文件目录
│       └── index.html  # 模板文件
└── utils/              # 工具类目录
    ├── __init__.py     # 初始化文件
    └── helper.py       # 辅助函数文件

目录说明：

• .gitignore: 指定 Git 忽略的文件和目录。
• .env.example: 环境变量配置示例文件。
• Dockerfile: 用于构建项目的 Docker 容器。
• README.md: 项目介绍文件。
• LICENSE: 开源许可证文件。
• config/: 配置文件目录，包含项目的基础配置和本地开发环境配置。
• manage.py: 管理脚本，用于执行项目管理任务。
• requirements.txt: 列出了项目运行所依赖的 Python 包。
• run.py: 项目启动文件。
• survey/: 调查问卷模块目录，包含模型的定义、视图处理和模板。
• utils/: 工具类目录，包含项目中使用的辅助函数。

2. 项目的启动文件介绍

run.py 是项目的启动文件，其内容如下：

from survey import create_app

app = create_app()

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

启动文件说明：

• 从 survey 模块导入 create_app 函数。
• 使用 create_app 函数创建一个应用实例。
• 如果当前文件是主程序，则启动应用，开启调试模式。

3. 项目的配置文件介绍

项目配置文件位于 config 目录下，包含两个文件：base.py 和 local.py。

base.py 基础配置文件：

class Config:
    SECRET_KEY = 'your_secret_key'
    SQLALCHEMY_DATABASE_URI = 'sqlite:///default.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

local.py 本地开发环境配置文件：

from config.base import Config

class LocalConfig(Config):
    DEBUG = True
    SQLALCHEMY_DATABASE_URI = 'sqlite:///local.db'

配置文件说明：

• Config: 基础配置类，定义了一些基本配置，如密钥和数据库连接。
• LocalConfig: 继承自 Config，为本地开发环境提供了额外的配置，如开启调试模式和本地数据库连接。

启动项目时，可以通过设置环境变量 FLASK_ENV 为 local 来使用本地配置文件。