🧠 Dump all your files and thoughts into your private GenerativeAI Second Brain and chat with it 🧠
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.
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
https://github.com/StanGirard/quivr/assets/19614572/80721777-2313-468f-b75e-09379f694653
https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5
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:
Additionally, you'll need a Supabase account for:
Step 0: If needed, here is the installation explained on Youtube here
Step 1: Clone the repository using one of these commands:
git clone https://github.com/StanGirard/Quivr.git && cd Quivr
git clone [email protected]:StanGirard/Quivr.git && cd Quivr
Step 2: Copy the .XXXXX_env
files
cp .backend_env.example backend/.env
cp .frontend_env.example frontend/.env
backend/.env
and frontend/.env
fileYour
supabase_service_key
can be found in your Supabase dashboard under Project Settings -> API. Use theanon
public
key found in theProject API keys
section.
Your
JWT_SECRET_KEY
can 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
bacend/.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 migration scripts on the Supabase database via the web interface (SQL Editor -> New query
)
If you come from an old version of Quivr, you can use the migration script to migrate your data to the new version
docker compose -f docker-compose.yml up --build
Step 6: Navigate to localhost:3000
in 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, and feel free to bring your fresh ideas to the table!