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 1: Clone the repository:
git clone https://github.com/StanGirard/Quivr.git && cd Quivr
Step 2: Copy the
cp .env.example .env
Step 3: Update the
vim .env # or emacs or vscode or nano
Update OPENAI_API_KEY in the
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.
Step 4: Launch the project
docker compose pull docker compose up --build # if OPENAI # docker compose -f docker-compose-ollama.yml up --build # Only if using Ollama. You need to run `ollama run llama2` first.
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
Connect to the supabase database at http://localhost:8000/project/default/auth/users with the following credentials: admin/admin in order to create new users. Auto-confirm the email.
You can now sign in to the app with your new user. You can access the app at http://localhost:3000/login.
You can access Quivr backend API at http://localhost:5050/docs
Step 1: Pull the latest changes
Step 2: Use the
migration.sh script to run the migration scripts
chmod +x migration.sh ./migration.sh # Select 2) Run migrations
Alternatively, you can run the script on the Supabase database via the web
interface (SQL Editor ->
New query -> paste the script ->
All the scripts can be found in the scripts folder
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 sponsors. Thank you for your support!
This project is licensed under the Apache 2.0 License - see the LICENSE file for details