Quivr - Your Second Brain, Empowered by Generative AI

Quivr, your second brain, utilizes the power of GenerativeAI to be your personal assistant ! Think of it as Obsidian, but turbocharged with AI capabilities.

Roadmap here

Key Features 🎯

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 newer.
File Compatibility: Text, Markdown, PDF, Powerpoint, Excel, CSV, Word, Audio, Video
Open Source: Freedom is beautiful, and so is Quivr. Open source and free to use.
Public/Private: Share your brains with your users via a public link, or keep them private.
Marketplace: Share your brains with the world, or use other people's brains to boost your productivity.
Offline Mode: Quivr works offline, so you can access your data anytime, anywhere.

Demo Highlights 🎥

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

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.

Prerequisites 📋

Ensure you have the following installed:

Docker
Docker Compose

60 seconds Installation 💽

Step 0: If needed, the installation is 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: Install prerequisites:

  brew install gum # Windows (via Scoop) scoop install charm-gum
  brew install postgresql # Windows (via Scoop) scoop install postgresql

Step 3: Copy the .env.example files
```
cp .env.example .env
```
Step 4: Update the .env files

Update OPENAI_API_KEY in the .env file.

You just need to update the OPENAI_API_KEY variable in the .env file. You can get your API key here. You need to create an account first. And put your credit card information. Don't worry, you won't be charged unless you use the API. You can find more information about the pricing here.

vim .env # or emacs or vscode or nano

Quivr can be installed offline and is compatible with Ollama.ai , in order to do so, follow the instructions here. It requires some technical expertise. If you need help, feel free to join our Discord and ask for help. The OPENAI_API_KEY is still required if you install Quivr offline but you can put whatever you want in the .env file.

Step 5: Launch the db

docker compose pull 

docker compose up db -d

Step 6: Use the migration.sh script to run the migration scripts
```
chmod +x migration.sh
./migration.sh
# Select  1) Create all tables
```
Choose either Create all tables if it's your first time or Run migrations if you are updating your database.

Alternatively, you can run the script on the Supabase database via the web interface (SQL Editor -> New query -> paste the script -> Run)

All the scripts can be found in the scripts folder
Step 7: Launch the app
```
docker compose up --build
```
Step 8: Navigate to localhost:8000 in your browser

Once Quivr is running, you need to create an account to access the app. User is admin and password is admin. Go to http://localhost:8000/project/default/auth/users and create a new user in the Users section. You can then log in with your new user.

Step 9: Login to the app

You can now sign in to the app with your new user. You can access the app at http://localhost:3000/login.

Contributors ✨

Thanks go to these wonderful people:

Contribute 🤝

Did you get 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!