ResearchGPT 项目教程

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

researchgpt/
├── static/
├── templates/
├── LICENSE
├── README.md
├── main.py
├── requirements.txt

• static/: 存放静态文件，如CSS、JavaScript等。
• templates/: 存放HTML模板文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• main.py: 项目的启动文件。
• requirements.txt: 项目的依赖文件，列出了项目运行所需的Python包。

2. 项目的启动文件介绍

main.py 是项目的启动文件，负责启动整个应用程序。以下是 main.py 的主要内容：

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates

app = FastAPI()

app.mount("/static", StaticFiles(directory="static"), name="static")
templates = Jinja2Templates(directory="templates")

@app.get("/")
def read_root():
    return {"Hello": "World"}

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

• FastAPI: 是一个现代、快速（高性能）的Web框架，用于构建API。
• StaticFiles: 用于挂载静态文件目录。
• Jinja2Templates: 用于加载HTML模板。
• app.get("/"): 定义了一个根路径的GET请求处理函数。
• app.get("/items/{item_id}"): 定义了一个带有路径参数的GET请求处理函数。

3. 项目的配置文件介绍

requirements.txt 是项目的配置文件之一，列出了项目运行所需的Python包及其版本。以下是 requirements.txt 的内容示例：

fastapi==0.68.1
uvicorn==0.15.0
jinja2==3.0.1

• fastapi: 项目的Web框架。
• uvicorn: 用于运行FastAPI应用的服务器。
• jinja2: 用于模板渲染的库。

通过安装这些依赖，可以确保项目在本地或服务器上正常运行。安装命令如下：

pip install -r requirements.txt

以上是 ResearchGPT 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。