【亲测免费】 Quivr 项目安装与使用教程

1. 项目目录结构及介绍

Quivr 项目的目录结构如下：

quivr/
├── backend/
│   ├── cms/
│   │   └── quivr/
│   ├── env.example
│   ├── flake8
│   ├── gitignore
│   ├── pre-commit-config.yaml
│   ├── readthedocs.yaml
│   ├── release-please-manifest.json
│   ├── run_tests.sh
│   ├── CHANGELOG.md
│   ├── LICENSE
│   ├── Makefile
│   ├── Pipfile
│   ├── README.md
│   ├── docker-compose.dev.yml
│   ├── docker-compose.yml
│   ├── logo.png
│   ├── release-please-config.json
│   ├── renovate.json
│   └── vercel.json
├── frontend/
│   ├── project/
│   │   └── inlang/
│   ├── env.example
│   ├── flake8
│   ├── gitignore
│   ├── pre-commit-config.yaml
│   ├── readthedocs.yaml
│   ├── release-please-manifest.json
│   ├── run_tests.sh
│   ├── CHANGELOG.md
│   ├── LICENSE
│   ├── Makefile
│   ├── Pipfile
│   ├── README.md
│   ├── docker-compose.dev.yml
│   ├── docker-compose.yml
│   ├── logo.png
│   ├── release-please-config.json
│   ├── renovate.json
│   └── vercel.json
└── README.md

目录结构介绍

• backend/: 后端代码目录，包含 CMS 相关文件和其他后端配置文件。
• frontend/: 前端代码目录，包含项目相关文件和其他前端配置文件。
• README.md: 项目的主文档文件，包含项目的基本介绍和使用说明。

2. 项目启动文件介绍

Quivr 项目的启动文件主要集中在 backend/ 和 frontend/ 目录下的 docker-compose.yml 文件。

docker-compose.yml

该文件用于定义和运行多容器 Docker 应用程序。通过 docker-compose up 命令可以启动整个项目。

version: '3.8'
services:
  backend:
    build: ./backend
    ports:
      - "5050:5050"
    volumes:
      - ./backend:/app
    environment:
      - OPENAI_API_KEY=your_openai_api_key
  frontend:
    build: ./frontend
    ports:
      - "3000:3000"
    volumes:
      - ./frontend:/app

启动命令

cd backend
supabase start
cd ../
docker-compose pull
docker-compose up

3. 项目配置文件介绍

Quivr 项目的配置文件主要集中在 backend/ 和 frontend/ 目录下的 .env 文件。

.env 文件

.env 文件用于存储项目的配置变量，如 API 密钥、数据库连接信息等。

# backend/.env
OPENAI_API_KEY=your_openai_api_key

# frontend/.env
REACT_APP_API_URL=http://localhost:5050

配置文件更新

在启动项目之前，需要根据实际情况更新 .env 文件中的配置变量。

cp env.example .env
vim .env

更新 OPENAI_API_KEY 变量，并保存文件。

通过以上步骤，您可以成功安装并启动 Quivr 项目，并根据需要进行配置。