【亲测免费】 Yuxi-Know 开源项目使用教程

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

Yuxi-Know 项目是一个基于大模型 RAG 知识库与知识图谱问答系统的开源项目，其目录结构如下：

Yuxi-Know/
│
├── .github/              # GitHub 相关配置文件
├── docker/               # Docker 配置文件
├── docs/                 # 文档资料
├── images/               # 项目图片资源
├── scripts/              # 脚本文件
├── src/                  # 源代码目录
│   ├── .env.template     # 环境变量模板文件
│   ├── static/           # 静态资源文件
│   ├── templates/        # 模板文件
│   └── app.py            # Flask 应用的主入口文件
│
├── test/                 # 测试相关文件
├── web/                  # 前端代码目录
├── .dockerignore         # Docker 忽略文件
├── .gitignore            # Git 忽略文件
├── LICENSE               # 开源协议文件
├── README.md             # 项目说明文件
├── requirements.txt      # 项目依赖文件
└── ...

主要目录和文件说明：

• .github/: 存放 GitHub 的一些配置文件，如 issue 模板等。
• docker/: 包含 Docker 配置文件，用于容器化部署项目。
• docs/: 存放项目文档资料。
• images/: 存放项目相关的图片资源。
• scripts/: 存放项目运行过程中需要的脚本文件。
• src/: 源代码目录，包含项目的核心代码。
  • .env.template: 环境变量配置模板文件。
  • static/: 存放静态资源，如 CSS、JavaScript 文件等。
  • templates/: 存放 HTML 模板文件。
  • app.py: Flask 应用的主入口文件。
• test/: 测试相关文件，用于项目测试。
• web/: 前端代码目录，包含 Vue.js 相关代码。
• .dockerignore: Docker 忽略文件，用于指定不需要添加到 Docker 镜像中的文件。
• .gitignore: Git 忽略文件，用于指定不需要添加到 Git 仓库中的文件。
• LICENSE: 开源协议文件，本项目采用 MIT 协议。
• README.md: 项目说明文件，介绍项目相关信息。
• requirements.txt: 项目依赖文件，列出项目所需的 Python 包。

2. 项目的启动文件介绍

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

from flask import Flask
# 其他导入...

app = Flask(__name__)
# 配置应用...

# 路由和视图函数...
@app.route('/')
def index():
    # 页面渲染逻辑...
    return ...

# 其他路由和视图函数...

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

在 app.py 文件中，首先导入了 Flask 相关模块，然后创建了一个 Flask 应用实例。接着，定义了路由和视图函数，最后在 if __name__ == '__main__': 下启动应用。

3. 项目的配置文件介绍

项目的配置文件主要有两个：.env.template 和 app.py 中的配置部分。

.env.template

.env.template 文件是一个环境变量配置模板文件，用于定义项目所需的环境变量。以下是 .env.template 文件的内容示例：

SILICONFLOW_API_KEY=your_api_key
OPENAI_API_KEY=your_api_key
DEEPSEEK_API_KEY=your_api_key
ZHIPUAI_API_KEY=your_api_key
# 其他环境变量...

在项目部署时，需要根据实际情况填写相应的 API 密钥，并将 .env.template 文件复制为 .env 文件，然后在 app.py 中加载这些环境变量。

app.py 中的配置

在 app.py 文件中，可以配置 Flask 应用的各种参数，如数据库连接、中间件、静态文件路径等。以下是一些配置示例：

app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///your-database.db'
app.config['SECRET_KEY'] = 'your-secret-key'
# 其他配置...

这些配置通常在 app.py 的顶部进行设置，以确保 Flask 应用在启动时加载这些配置。