DocNavigator
DocNavigator是一个由AI驱动的聊天机器人构建工具,旨在改善产品文档/支持网站的用户体验。它可以根据公司网站上的数据进行训练,为任何规模的组织提供一个可扩展的解决方案。
凭借其处理多个查询的能力,DocNavigator可以为客户节省时间,提高生产力,同时改善客户满意度。
要开始这个项目,您需要创建一个.env
文件。示例.env
文件可以在example.env
文件中找到。.env
文件接受以下变量:
APP_URL
:您应用程序托管的根路径,例如:https://localhost:3000OPENAI_API_KEY
:OpenAI的API密钥。NEXT_PUBLIC_SUPABASE_URL
:您的Supabase实例的URL。//为此在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
来访问该应用程序。
贡献
如果您想为此项目做出贡献,请按照以下步骤操作:
- 派生存储库
- 创建新分支(
git checkout -b feature/my-new-feature
) - 进行更改
- 提交更改(
git commit -am 'Add some feature'
) - 推送到分支(
git push origin feature/my-new-feature
) - 创建新的拉取请求
星历史
许可证
此项目根据Apache-2.0许可证授权 - 有关详细信息,请参阅许可证文件。