QuivrHQ / quivr
- четверг, 22 февраля 2024 г. в 00:00:07
Your GenAI Second Brain 🧠 A personal productivity assistant (RAG) ⚡️🤖 Chat with your docs (PDF, CSV, ...) & apps using Langchain, GPT 3.5 / 4 turbo, Private, Anthropic, VertexAI, Ollama, LLMs, that you can share with users ! Local & Private alternative to OpenAI GPTs & ChatGPT powered by retrieval-augmented generation.
Quivr, your second brain, utilizes the power of GenerativeAI to be your personal assistant ! Think of it as Obsidian, but turbocharged with AI capabilities.
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.
Ensure you have the following installed:
You can find the installation video here.
Step 0: Supabase CLI
Follow the instructions here to install the Supabase CLI that is required.
supabase -v # Check that the installation worked
Step 1: Clone the repository:
git clone https://github.com/quivrhq/quivr.git && cd Quivr
Step 2: Copy the .env.example
files
cp .env.example .env
Step 3: Update the .env
files
vim .env # or emacs or vscode or nano
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.
Don't want to use OpenAI and want to use Ollama instead for a completely private experience? You can find the instructions here.
Step 4: Launch the project
supabase start
and then
docker compose pull
docker compose up
If you have a Mac, go to Docker Desktop > Settings > General and check that the "file sharing implementation" is set to VirtioFS
.
If you are a developer, you can run the project in development mode with the following command: docker compose -f docker-compose.dev.yml up --build
Step 5: Login to the app
You can now sign in to the app with admin@quivr.app
& admin
. You can access the app at http://localhost:3000/login.
You can access Quivr backend API at http://localhost:5050/docs
You can access supabase at http://localhost:54323
Step 1: Pull the latest changes
git pull
Step 2: Update the migration
supabase migration up
Thanks go to these wonderful people:
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!
This project would not be possible without the support of our partners. Thank you for your support!
This project is licensed under the Apache 2.0 License - see the LICENSE file for details