Tchatchers 开源项目使用教程

Tchatchers 开源项目使用教程

tchatcherstchatchers is a blazing fast chat application built with Axum and Yew.rs项目地址:https://gitcode.com/gh_mirrors/tc/tchatchers

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

tchatchers/
├── README.md
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── user.py
│   │   └── chat.py
│   ├── routes/
│   │   ├── __init__.py
│   │   ├── user_routes.py
│   │   └── chat_routes.py
│   └── utils/
│       ├── __init__.py
│       ├── helpers.py
│       └── validators.py
├── tests/
│   ├── __init__.py
│   ├── test_main.py
│   └── test_models.py
├── requirements.txt
└── setup.py

目录结构说明

• app/: 包含应用程序的主要代码。
  • __init__.py: 初始化应用程序包。
  • main.py: 应用程序的入口文件。
  • config.py: 配置文件。
  • models/: 包含数据模型。
  • routes/: 包含路由定义。
  • utils/: 包含辅助函数和工具类。
• tests/: 包含测试代码。
• requirements.txt: 项目依赖列表。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

app/main.py

from flask import Flask
from app.config import Config
from app.routes import user_routes, chat_routes

def create_app():
    app = Flask(__name__)
    app.config.from_object(Config)

    app.register_blueprint(user_routes.bp)
    app.register_blueprint(chat_routes.bp)

    return app

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

启动文件说明

• create_app(): 创建并配置Flask应用实例，注册蓝图（Blueprints）。
• if __name__ == "__main__":: 当文件作为主程序运行时，启动应用。

3. 项目的配置文件介绍

app/config.py

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'you-will-never-guess'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///app.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

配置文件说明

• SECRET_KEY: 用于会话加密的密钥。
• SQLALCHEMY_DATABASE_URI: 数据库连接URI。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否追踪对象的修改。

tchatcherstchatchers is a blazing fast chat application built with Axum and Yew.rs项目地址:https://gitcode.com/gh_mirrors/tc/tchatchers