EyeNet 项目启动与配置教程

1. 项目目录结构及介绍

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

eyenet/
├── Dockerfile             # Docker构建文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── Requirement.txt       # 项目依赖文件
├── app/                  # 应用程序主目录
│   ├── __init__.py
│   ├── main.py           # 主程序文件
│   ├── models.py         # 数据模型文件
│   ├── static/           # 静态文件目录
│   │   └── ...
│   ├── templates/        # 模板文件目录
│   │   └── ...
│   └── ...
├── config/               # 配置文件目录
│   ├── __init__.py
│   └── settings.py       # 配置文件
├── data/                 # 数据目录
│   └── ...
├── logs/                 # 日志文件目录
│   └── ...
└── tests/                # 测试代码目录
    └── ...

项目目录说明：

• Dockerfile：用于构建Docker镜像的文件。
• LICENSE：项目遵循的许可证信息。
• README.md：项目的基本信息和说明。
• Requirement.txt：项目运行所需的Python库和依赖。
• app：主应用程序目录，包含项目的核心代码。
• config：配置文件目录，存放项目的配置信息。
• data：数据存储目录，用于存放项目数据文件。
• logs：日志文件目录，用于存放运行日志。
• tests：测试代码目录，包含项目的单元测试。

2. 项目的启动文件介绍

项目的启动文件为app/main.py，以下是启动文件的简单介绍：

from app import create_app

app = create_app()

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

main.py文件中首先从app模块导入create_app函数，然后调用该函数创建应用实例。如果该文件作为主程序运行，将启动应用服务器，并设置调试模式为开启。

3. 项目的配置文件介绍

项目的配置文件为config/settings.py，以下是配置文件的简单介绍：

import os

class Config:
    """设置EyeNet的配置参数"""
    
    # 一般设置
    SECRET_KEY = os.getenv('SECRET_KEY', 'default_secret_key')
    DEBUG = os.getenv('DEBUG', True)
    
    # 数据库配置
    SQLALCHEMY_DATABASE_URI = os.getenv('DATABASE_URL', 'sqlite:///eyenet.db')
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    
    # 其他配置...

settings.py文件定义了一个Config类，其中包含了一些基本配置，如秘密密钥、调试模式、数据库连接字符串等。这些配置可以通过环境变量来设置，也可以使用默认值。配置文件允许开发者根据环境或需求调整项目配置，增强项目的灵活性和可维护性。