# Quivr - Your Second Brain, Empowered by Generative AI
Quivr-logo
[![Discord Follow](https://dcbadge.vercel.app/api/server/HUpRgp2HG8?style=flat)](https://discord.gg/HUpRgp2HG8) [![GitHub Repo stars](https://img.shields.io/github/stars/stangirard/quivr?style=social)](https://github.com/stangirard/quivr) [![Twitter Follow](https://img.shields.io/twitter/follow/StanGirard?style=social)](https://twitter.com/_StanGirard) 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](https://brain.quivr.app/docs/roadmap) ## 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](https://brain.quivr.app/). Quivr can be installed offline, in order to do so, follow the instructions [here](https://brain.quivr.app/docs/Developers/selfHosted/run_fully_local). It requires some technical expertise. If you need help, feel free to join our [Discord](https://discord.gg/HUpRgp2HG8) and ask for help. ### Prerequisites 📋 Ensure you have the following installed: - Docker - Docker Compose Additionally, you'll need a [Supabase](https://supabase.com/) 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](https://youtu.be/rC-s4QdfY80) - **Step 1**: Clone the repository using **one** of these commands: - If you don't have an SSH key set up: ```bash 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](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)) ```bash git clone git@github.com:StanGirard/Quivr.git && cd Quivr ``` - **Step 2**: Use the install helper script to automate subsequent steps. You can use the install_helper.sh script to setup your env files and execute the migrations. prerequisites: ```bash brew install gum # Windows (via Scoop) scoop install charm-gum brew install postgresql # Windows (via Scoop) scoop install postgresql ``` ```bash chmod +x install_helper.sh ./install_helper.sh ``` If you want to manually set up the environment, follow the steps below, otherwise skip to Step 6. - **Step 2 - Bis**: Copy the `.XXXXX_env` files ```bash 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_KEY` can 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._ - Change variables in `backend/.env` - Change variables in `frontend/.env` - **Step 4**: Use the `migration.sh` script to run the migration scripts ```bash 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](scripts/) folder > _If you come from an old version of Quivr, run the scripts in [migration script](scripts/) to migrate your data to the new version in the order of date_ - **Step 5**: Launch the app ```bash docker compose up --build ``` - **Step 6**: Navigate to `localhost:3000` in your browser Once Quivr is running, you need to create an account to access the app. Go to supabase and create a new user in the `Users` section. You can then log in with your new user. - **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 🤝 Did you get a pull request? Open it, and we'll review it as soon as possible. Check out our project board [here](https://github.com/users/StanGirard/projects/5) to see what we're currently focused on, and feel free to bring your fresh ideas to the table! - [Open Issues](https://github.com/StanGirard/quivr/issues) - [Open Pull Requests](https://github.com/StanGirard/quivr/pulls) - [Good First Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) - [Frontend Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Afrontend) - [Backend Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Abackend) ## Sponsors ❤️ This project would 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](LICENSE) file for details ## Stars History 📈 [![Star History Chart](https://api.star-history.com/svg?repos=StanGirard/quivr&type=Timeline)](https://star-history.com/#StanGirard/quivr&Timeline)