Skip to content

Latest commit

 

History

History
189 lines (126 loc) · 7.03 KB

README.md

File metadata and controls

189 lines (126 loc) · 7.03 KB
Raw

Quivr - Your Second Brain, Empowered by Generative AI

Quivr-logo

Discord Follow GitHub Repo stars Twitter Follow

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, and so is Quivr. Open source and free to use.

Demo Highlights 🎥

quivr-demo-new.mp4

Disclaimer ⚠️

For a little while, Quivr will be only compatible with OpenAI API.

If you want to use a Local LLM please refer to v0.0.46.

This is due to us preparing a big feature and needing to clean the code a bit.

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

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, 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: Use the install helper

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

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

chmod +x install_helper.sh
./install_helper.sh

  • Step 2 - Bis: 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 -> API -> JWT Settings -> JWT Secret

    The NEXT_PUBLIC_BACKEND_URL is set to localhost:5050 for the docker. Update it if you are running the backend on a different machine.

    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: Use the migration.sh script to run the migration scripts

    chmod +x migration.sh
./migration.sh

    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

    If you come from an old version of Quivr, run the scripts in migration script to migrate your data to the new version in the order of date

  • Step 5: Launch the app

    docker compose 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

Contributors ✨

Thanks go 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!

Sponsors ❤️

This project could not be possible without the support of our sponsors. Thank you for your support!

Theodo Padok Aleios BAM Sicara

License 📄

This project is licensed under the Apache 2.0 License - see the LICENSE file for details

Stars History 📈

Star History Chart