开源项目open-deep-research使用教程

开源项目open-deep-research使用教程

open-deep-research An open source deep research clone. AI Agent that reasons large amounts of web data extracted with Firecrawl 项目地址: https://gitcode.com/gh_mirrors/ope/open-deep-research

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

开源项目open-deep-research的目录结构如下：

open-deep-research/
├── app/
│   ├── components/
│   ├── hooks/
│   ├── lib/
│   └── public/
├── components.json
├── docker-compose.yml
├── drizzle.config.ts
├── middleware.ts
├── next-env.d.ts
├── next.config.ts
├── package.json
├── pnpm-lock.yaml
├── postcss.config.mjs
├── README.md
├── start.sh
├── tailwind.config.ts
├── tsconfig.json
└── .dockerignore

目录说明：

• app/: 存放应用的主要代码，包括组件、钩子、库和公共文件。
• components/: 存放React组件。
• hooks/: 存放自定义的React钩子。
• lib/: 存放项目库代码，如API调用、工具函数等。
• public/: 存放公共静态文件，如图片、CSS文件等。
• components.json: 定义项目中的组件。
• docker-compose.yml: 定义Docker服务的配置。
• drizzle.config.ts: 配置Drizzle相关的设置。
• middleware.ts: 项目的中间件配置。
• next-env.d.ts: Next.js环境类型定义。
• next.config.ts: Next.js配置文件。
• package.json: 项目的包依赖和脚本。
• pnpm-lock.yaml: pnpm的锁定文件，记录依赖的精确版本。
• postcss.config.mjs: PostCSS的配置文件。
• README.md: 项目的说明文件。
• start.sh: 启动脚本的shell文件。
• tailwind.config.ts: Tailwind CSS的配置文件。
• tsconfig.json: TypeScript的配置文件。
• .dockerignore: 定义Docker构建时需要忽略的文件。

2. 项目的启动文件介绍

项目的启动主要通过start.sh脚本和package.json中的脚本实现。

start.sh

该脚本用于启动Docker容器：

#!/bin/bash
docker-compose up -d

package.json

在package.json中，定义了多个启动脚本，例如：

{
  "scripts": {
    "dev": "next dev",
    "build": "next build && next start",
    // 其他脚本...
  }
}

使用以下命令可以启动开发服务器：

pnpm dev

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

next.config.ts

这是Next.js的配置文件，用于配置如路由、环境变量等。

// next.config.js 的示例内容
module.exports = {
  // 配置项...
}

drizzle.config.ts

这是Drizzle的配置文件，用于配置数据存储相关设置。

// drizzle.config.ts 的示例内容
export default {
  // 配置项...
}

tailwind.config.ts

这是Tailwind CSS的配置文件，用于定制化CSS样式。

// tailwind.config.js 的示例内容
module.exports = {
  // 配置项...
}

.env.example

这是环境变量的示例文件，用于展示需要设置的环境变量。

# .env.example 的示例内容
OPENROUTER_API_KEY=your_api_key

在实际部署时，需要创建一个.env文件，并填入相应的环境变量值，但不要将这个文件提交到代码仓库中，以免泄露敏感信息。

open-deep-research An open source deep research clone. AI Agent that reasons large amounts of web data extracted with Firecrawl 项目地址: https://gitcode.com/gh_mirrors/ope/open-deep-research