SubChat 项目启动与配置教程

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

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

SubChat/
├── .gitignore           # Git 忽略文件列表
├── Dockerfile           # Docker 容器配置文件
├── README.md            # 项目说明文件
├── config/              # 配置文件目录
│   ├── app.json         # 应用配置文件
│   └── database.json    # 数据库配置文件
├── docs/                # 文档目录
├── public/              # 公共静态文件目录
│   ├── css/
│   ├── js/
│   └── images/
├── src/                 # 源代码目录
│   ├── main.py          # 项目入口文件
│   ├── models.py        # 数据模型文件
│   ├── routes.py        # 路由配置文件
│   └── utils.py         # 工具函数文件
└── tests/               # 测试代码目录

• .gitignore：指定 Git 忽略跟踪的文件和目录。
• Dockerfile：用于创建 Docker 容器的配置文件。
• README.md：项目的详细说明，包括项目介绍、安装、配置和使用指南。
• config/：包含项目配置文件。
  • app.json：应用级别的配置信息，如端口、数据库连接等。
  • database.json：数据库配置信息，如数据库类型、用户名、密码等。
• public/：存放公共静态文件，如 CSS、JavaScript 和图片等。
• src/：项目源代码所在目录。
  • main.py：项目的入口文件，负责初始化和启动服务。
  • models.py：定义数据模型。
  • routes.py：配置路由。
  • utils.py：辅助工具类。
• tests/：存放测试代码，确保项目功能的正确性。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。该文件负责初始化应用、配置路由、设置数据库连接等，并最终启动服务。下面是 main.py 的基本结构：

from flask import Flask
from models import db
from routes import routes

app = Flask(__name__)
app.config.from_json('config/app.json')
db.init_app(app)
app.register_blueprint(routes)

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

在 main.py 文件中，我们首先导入必要的模块，然后创建一个 Flask 应用实例，并从配置文件 app.json 中加载配置。接着初始化数据库，并注册路由。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，主要包括 app.json 和 database.json。

app.json

app.json 是应用级别的配置文件，包含应用的运行参数，如端口、数据库连接信息等。文件内容如下：

{
  "host": "0.0.0.0",
  "port": 5000,
  "secret_key": "your_secret_key"
}

database.json

database.json 是数据库配置文件，包含数据库的连接参数，如数据库类型、用户名、密码等。文件内容如下：

{
  "db_type": "sqlite",
  "db_name": "subchat.db"
}

在项目启动时，main.py 会加载这些配置文件，并根据配置信息初始化应用和数据库。