StanGirard/quivr
1
1
Fork 0
mirror of https://github.com/StanGirard/quivr.git synced 2024-12-26 04:42:31 +03:00
Code Issues Packages Projects Releases Wiki Activity
🧠 Dump all your files and chat with it using your Generative AI Second Brain using LLMs ( GPT 3.5/4, Private, Anthropic, VertexAI ) & Embeddings 🧠
160 Commits 837 Branches 349 Tags 203 MiB
Python 99.2%
Shell 0.8%
e0de23e24d
Go to file
Stan Girard e0de23e24d
Feat/single brain (#215) 
* feat(llm): update

* feat(singlebrain): added new table with user-id

* feat(user): get user from email

* feat(user_id): added search

* ✨ add user_id to most endpoints

* docs(readme): new script

---------

Co-authored-by: gozineb <zinebe@theodo.fr>
2023-05-31 13:51:23 +02:00
.github Chore: add husky, no-unused-vars & no-explicit-any eslint rules (#168) 2023-05-26 13:56:29 +02:00
.vscode Chore: add husky, no-unused-vars & no-explicit-any eslint rules (#168) 2023-05-26 13:56:29 +02:00
backend Feat/single brain (#215) 2023-05-31 13:51:23 +02:00
frontend chore(docker): use yarn.lock instead of package-lock.json (#213) 2023-05-30 19:16:28 +02:00
scripts Feat/single brain (#215) 2023-05-31 13:51:23 +02:00
streamlit-demo fix(streamlit): requirements.txt 2023-05-21 01:27:36 +02:00
.backend_env.example chore(.env): remove unnecessary quotes from values (#189) 2023-05-28 22:32:16 +02:00
.frontend_env.example chore(.env): remove unnecessary quotes from values (#189) 2023-05-28 22:32:16 +02:00
.gitignore chore(yarn): added yarn.lock 2023-05-26 14:28:15 +02:00
docker-compose.yml Better envs 2023-05-21 21:18:55 -07:00
LICENSE feat(license): added 2023-05-13 18:12:35 +02:00
logo.png docs(readme): making it nice (#102) 2023-05-21 14:53:47 +02:00
README.md Feat/single brain (#215) 2023-05-31 13:51:23 +02:00

README.md

Quivr - Your Second Brain, Empowered by Generative AI

Quivr-logo

Quivr, your second brain, utilizes the power of GenerativeAI to store and retrieve unstructured information. Think of it as Obsidian, but turbocharged with AI capabilities.

Key Features 🎯

  • Universal Data Acceptance: Quivr can handle almost any type of data you throw at it. Text, images, code snippets, we've got you covered.
  • Generative AI: Quivr employs advanced AI to assist you in generating and retrieving information.
  • Fast and Efficient: Designed with speed and efficiency at its core. Quivr ensures rapid access to your data.
  • Secure: Your data, your control. Always.
  • File Compatibility:
    • Text
    • Markdown
    • PDF
    • Powerpoint
    • Excel
    • Word
    • Audio
    • Video
  • Open Source: Freedom is beautiful, so is Quivr. Open source and free to use.

Demo Highlights 🎥

Please note: The DEMO WITH STREAMLIT IS USING AN OLD VERSION
The new version showcases a fresh UI, however, it is not yet deployed as it lacks some features of the old version. Expected to go live before 25/05/23

Demo with GPT3.5:

https://github.com/StanGirard/quivr/assets/19614572/80721777-2313-468f-b75e-09379f694653

Demo with Claude 100k context: https://github.com/StanGirard/quivr/assets/5101573/9dba918c-9032-4c8d-9eea-94336d2c8bd4

Demo of the new version (Work in progress):

https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5

Getting Started: New Version 🚀

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Old version's readme is located in the streamlit-demo folder here

Prerequisites 📋

Before you proceed, ensure you have the following installed:

  • Docker
  • Docker Compose

Additionally, you'll need a Supabase account for:

  • Creating a new Supabase project
  • Supabase Project API key
  • Supabase Project URL

Installation Steps 💽

  • Step 0: If needed, here is the installation explained on Youtube here

  • Step 1: Clone the repository using one of these commands:

    • If you don't have an SSH key set up:
    git clone https://github.com/StanGirard/Quivr.git && cd Quivr
    • If you have an SSH key set up or want to add it (guide here)
    git clone git@github.com:StanGirard/Quivr.git && cd Quivr

  • Step 2: Copy the .XXXXX_env files

cp .backend_env.example backend/.env
cp .frontend_env.example frontend/.env
  • Step 3: Update the backend/.env and frontend/.env file

Your supabase_service_key can be found in your Supabase dashboard under Project Settings -> API. Use the anon public key found in the Project API keys section. Your JWT_SECRET_KEYcan be found in your supabase settings under Project Settings -> JWT Settings -> JWT Secret

  • Step 4: Run the following migration scripts on the Supabase database via the web interface (SQL Editor -> New query)

Migration Script 1

Migration Script 2

Migration Script 3

  • Step 5: Launch the app
docker compose build && docker compose up
  • Step 6: Navigate to localhost:3000 in your browser

Contributors ✨

Thanks goes to these wonderful people:

Contribute 🤝

Got a pull request? Open it, and we'll review it as soon as possible. Check out our project board here to see what we're currently focused on, and feel free to bring your fresh ideas to the table!