CRT 项目启动与配置教程

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

CRT 项目目录结构如下：

crt/
├── .gitignore           # 忽略Git提交的文件列表
├── Dockerfile           # Docker构建文件
├── README.md            # 项目说明文件
├── config/              # 配置文件目录
│   └── config.json      # 项目配置文件
├── docs/                # 文档目录
├── main/                # 主程序目录
│   ├── __init__.py
│   └── app.py           # 项目启动文件
├── requirements.txt     # 项目依赖文件
├── tests/               # 测试代码目录
└── utils/               # 工具模块目录

• .gitignore：指定Git应该忽略的文件和目录。
• Dockerfile：用于构建Docker镜像的文件。
• README.md：项目的说明文件，包含项目的介绍、安装和使用说明。
• config/：存放项目的配置文件。
  • config.json：项目的主要配置文件，包含数据库连接、端口号等信息。
• docs/：存放项目文档。
• main/：项目的主程序目录。
  • __init__.py：Python包的初始化文件。
  • app.py：项目的启动文件，负责初始化和运行项目。
• requirements.txt：列出项目所需的Python库和依赖。
• tests/：存放测试代码。
• utils/：存放项目通用的工具模块。

2. 项目的启动文件介绍

项目的启动文件位于 main/app.py。以下是启动文件的主要内容：

from flask import Flask
from config.config import Config

# 初始化Flask应用
app = Flask(__name__)
app.config.from_object(Config)

# 定义路由
@app.route('/')
def index():
    return 'Hello, CRT!'

# 启动应用
if __name__ == '__main__':
    app.run(debug=True)

启动文件使用Flask框架创建了一个Web应用，并定义了一个根路由 /，访问时返回 "Hello, CRT!"。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.json。以下是配置文件的主要内容：

{
    "database": {
        "uri": "sqlite:///data.db",
        "echo": true
    },
    "server": {
        "host": "0.0.0.0",
        "port": 5000,
        "debug": true
    }
}

配置文件包含了数据库连接信息（使用SQLite数据库）和服务器配置（包括监听地址、端口和调试模式）。这些配置信息在 main/app.py 中通过 Config 类进行加载和应用。