StanGirard/quivr: 🧠 Dump all your files and chat with it using your Generative AI Second Brain using LLMs ( GPT 3.5/4, Private, Anthropic, VertexAI ) & Embeddings 🧠

Tag

ChatGPT

Type

Code

URL

https://github.com/StanGirard/quivr

Created

Jul 11, 2023 02:37 AM

Quivr - Your Second Brain, Empowered by Generative AI

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.

Roadmap here

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.

OS Compatible: Ubuntu 22 or upper.

File Compatibility:

Text
Markdown
PDF
Powerpoint
Excel (Not Yet)
Csv
Word
Audio
Video

Open Source: Freedom is beautiful, so is Quivr. Open source and free to use.

Demo Highlights

Details

Getting Started:

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

You can find everything on the documentation 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:
If you have an SSH key set up or want to add it (guide here)

Step 2: Use the install helper

You can use the install_helper.sh script to setup your env files

Step 2 - Bis: Copy the .XXXXX_env files

Step 3: Update the backend/.env and frontend/.env file

Change variables in backend/.env

Change variables in frontend/.env

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

Use the migration.sh script to run the migration scripts

And choose either create_scripts if first time or migrations if you are updating your database

All scripts can be found in the scripts folder

Step 5: Launch the app

Step 6: Navigate to localhost:3000 in your browser

* Step 7**: Want to contribute to the project?

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!