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.
- 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
- Powerpoint
- Excel
- Word
- Audio
- Video
- Open Source: Freedom is beautiful, so is Quivr. Open source and free to use.
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
quiver-16.05.mp4
Demo with Claude 100k context: https://github.com/StanGirard/quivr/assets/5101573/9dba918c-9032-4c8d-9eea-94336d2c8bd4
quivr-demo-new.mp4
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
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
-
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_envfiles
cp .backend_env.example backend/.env
cp .frontend_env.example frontend/.env- Step 3: Update the
backend/.envandfrontend/.envfile
Your
supabase_service_keycan be found in your Supabase dashboard under Project Settings -> API. Use theanonpublickey found in theProject API keyssection.
Your
JWT_SECRET_KEYcan be found in your supabase settings under Project Settings -> JWT Settings -> JWT Secret
To activate vertexAI with PaLM from GCP follow the instructions here and update
backend/.env- It is an advanced feature, please be expert in GCP before trying to use it
-
Change variables in
backend/.env -
Change variables in
frontend/.env -
Step 4: Run the following scripts on the Supabase database via the web interface (SQL Editor ->
New query)
supabase_new_store_documents.sql
supabase_vector_store_summary.sql
- Step 5: Launch the app
docker compose -f docker-compose.yml up --build-
Step 6: Navigate to
localhost:3000in your browser -
Step 7: Want to contribute to the project?
docker compose -f docker-compose.dev.yml up --build
Thanks goes to these wonderful people:
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, a 664B nd feel free to bring your fresh ideas to the table!