DocNavigator

DocNavigator 项目介绍

DocNavigator 是一个利用人工智能技术构建的聊天机器人工具，旨在提升产品文档和支持网站的用户体验。该系统可根据公司网站上已有的数据进行训练，使其成为可扩展的解决方案，适合各种规模的组织机构使用。

功能和优势

DocNavigator 能够同时处理多个用户请求，这不仅节省了客户的时间，也提升了整体生产力。同时，它能够显著提高客户满意度，为用户提供更优质的服务体验。

开始使用

要启动 DocNavigator 项目，首先需要创建一个 .env 文件。可以参考项目中的 example.env 文件进行配置。.env 文件需要包括以下变量：

• APP_URL: 应用的主路径，例如 https://localhost:3000
• OPENAI_API_KEY: OpenAI 的 API 密钥
• NEXT_PUBLIC_SUPABASE_URL: Supabase 实例的网址（需要在 Supabase 上创建新项目）
• SUPABASE_SERVICE_ROLE_KEY: Supabase 实例的服务角色密钥（需要在 Supabase 上创建新项目）
• APP_SECRET: 用于签名 JWT 令牌的密钥
• USER_SIGNUP_LIMIT: 限制额外注册的数量
• DATABASE_URL: Supabase 数据库的连接字符串（需要在 Supabase 上创建新项目）

数据库初始化

在构建和运行 Docker 容器之前，需先使用以下命令初始化数据库：

# 初始化数据库
yarn run initDb

此操作会在 Supabase 数据库中创建必要的表和数据。

启动项目

完成 .env 文件创建和数据库初始化后，可以使用以下命令启动项目：

使用 Docker

# 构建 Docker 镜像
docker build -t doc-navigator .

# 运行 Docker 容器
docker run -p 3000:3000 doc-navigator

本地启动

# 安装依赖
yarn install

# 构建应用程序
yarn build

# 启动 Web 应用
yarn start

应用程序会运行于 3000 端口，用户可以通过浏览器访问 http://localhost:3000 来使用该应用。

贡献指南

如果您希望为这个项目贡献力量，请遵循以下步骤：

1. Fork 仓库
2. 创建新的分支 (git checkout -b feature/my-new-feature)
3. 修改代码
4. 提交更改 (git commit -am 'Add some feature')
5. 推送到分支 (git push origin feature/my-new-feature)
6. 创建一个新的 Pull Request

许可证

DocNavigator 项目依据 Apache-2.0 许可证开放，详情请查看 LICENSE 文件。