QuivrHQ/quivr
1
1
Fork 0
mirror of https://github.com/QuivrHQ/quivr.git synced 2024-12-15 01:21:48 +03:00
Code Issues Packages Projects Releases Wiki Activity
ad87641d19
quivr/backend/core/README.md
Stan Girard 380cf82706
feat: quivr core 0.1 (#2970) 
# Description


# Testing backend 

## Docker setup
1. Copy `.env.example` to `.env`. Some env variables were added :
EMBEDDING_DIM
2. Apply supabase migratrions : 
```sh
supabase stop
supabase db reset
supabase start
```
3. Start backend containers
```
make dev
```
## Local setup 
You can also run backend without docker.
1. Install [`rye`](https://rye.astral.sh/guide/installation/). Choose
the managed python version and set the version to 3.11
2. Run the following: 
```
cd quivr/backend
rye sync
```
3. Source `.venv` virtual env : `source .venv/bin/activate`
4. Run the backend, make sure you are running redis and supabase
API: 
```
LOG_LEVEL=debug uvicorn quivr_api.main:app --log-level debug --reload --host 0.0.0.0 --port 5050 --workers 1
```
Worker: 
```
LOG_LEVEL=debug celery -A quivr_worker.celery_worker worker -l info -E --concurrency 1
```
Notifier: 
```
LOG_LEVEL=debug python worker/quivr_worker/celery_monitor.py
```

---------

Co-authored-by: chloedia <chloedaems0@gmail.com>
Co-authored-by: aminediro <aminedirhoussi1@gmail.com>
Co-authored-by: Antoine Dewez <44063631+Zewed@users.noreply.github.com>
Co-authored-by: Chloé Daems <73901882+chloedia@users.noreply.github.com>
Co-authored-by: Zewed <dewez.antoine2@gmail.com>
2024-09-02 10:20:53 +02:00

1.2 KiB
Raw Blame History

quivr-core package

The RAG of Quivr.com

Contributors

Requirements

  1. Install poetry. Recommand the pipx install
  2. (Optional) Install (uv)[https://github.com/astral-sh/uv]
  3. git clone quivr
git clone git@github.com:QuivrHQ/quivr.git
cd quivr/backend/core

  1. Create virtual environement with your preferred tool

    uv venv

  2. Install base quivr-core environment

    poetry install -E base --with dev,test

  3. Install pre-commit

    pre-commit install

  4. Run example

    python examples/simple_question.py

Backend

  1. Install poetry. Recommand the pipx install
  2. (Optional) Install (uv)[https://github.com/astral-sh/uv]
  3. Clone quivr
cd quivr/backend/

  1. Create virtual environement with your preferred tool

    uv venv

  2. Install quivr-core monorepo

    poetry install

  3. Copy .env.example to .env and modify env variables : step 2 : (https://docs.quivr.app/install#60-seconds-installation)

  4. Run backend-api

LOG_LEVEL=debug uvicorn quivr_api.main:app --log-level debug --reload --host 0.0.0.0 --port 5050 --workers 1