Quivr 介绍

了解项目的详细信息和使用方法

Quivr - 你的第二个大脑，由生成式人工智能增强

Quivr，你的第二个大脑，利用生成式人工智能的力量存储和检索非结构化信息。将其视为 Obsidian，但配备了 AI 功能。

在一段时间内，Quivr 仅与 OpenAI API 兼容。

如果您想使用本地 LLM，请参考 v0.0.46。

这是因为我们正在准备一个重大功能，并需要对代码进行一些清理。

按照以下说明在本地机器上设置项目副本，用于开发和测试目的。

您可以在文档上找到所有内容。

确保已安装以下内容：

此外，您还需要一个 Supabase 帐户，用于：

步骤 0：如果需要，可以在 Youtube 上找到安装说明 here。
步骤 1：使用以下一种命令克隆存储库：
- 如果您没有设置 SSH 密钥：
```
bash
1git clone https://github.com/StanGirard/Quivr.git && cd Quivr
```
- 如果您已设置了 SSH 密钥或想要添加它（指南在这里）：
```
bash
1git clone [email protected]:StanGirard/Quivr.git && cd Quivr
```

步骤 2：使用安装助手

您可以使用 install_helper.sh 脚本设置您的 env 文件

bash
1brew install gum # Windows（通过 Scoop）scoop install charm-gum
2
3chmod +x install_helper.sh
4./install_helper.sh

步骤 2 - Bis：复制 .XXXXX_env 文件

bash
1cp .backend_env.example backend/.env
2cp .frontend_env.example frontend/.env

步骤 3：更新 backend/.env 和 frontend/.env 文件

您的 supabase_service_key 可在 Supabase 仪表板的项目设置 -> API 下找到。在 Project API keys 部分中使用 anon public 密钥。

您的 JWT_SECRET_KEY 可在 supabase 设置中的项目设置 -> API -> JWT 设置 -> JWT 密钥下找到。

NEXT_PUBLIC_BACKEND_URL 设置为 localhost:5050 以用于 docker。如果您在其他机器上运行后端，请更新它。

要使用 GCP 中的 PaLM 激活 vertexAI，请按照此处的说明进行操作 here，并更新 backend/.env- 这是一个高级功能，请在尝试使用之前成为 GCP 专家
- 更改 backend/.env 中的变量
- 更改 frontend/.env 中的变量
步骤 4：使用 migration.sh 脚本运行迁移脚本
```
bash
1chmod +x migration.sh
2./migration.sh
```
如果是第一次运行，请选择 Create all tables，如果您要更新数据库，请选择 Run migrations。

或者，您可以通过网络界面在 Supabase 数据库上运行脚本（SQL 编辑器 -> New query -> 粘贴脚本 -> Run）。

所有脚本都可以在 scripts 文件夹中找到。

如果您来自 Quivr 的旧版本，请按日期顺序运行 migration script 中的脚本，以将数据迁移到新版本

步骤 5：启动应用程序

bash
1docker compose -f docker-compose.yml up --build

步骤 7：想要为项目做出贡献吗？

docker compose -f docker-compose.dev.yml up --build

本项目基于 Apache 2.0 许可证进行许可 - 有关详细信息，请参阅 LICENSE 文件。