Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stangirard/quivr

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, Groq that you can share with users ! Local & Private alternative to OpenAI GPTs & ChatGPT powered by retrieval-augmented generation.
https://github.com/stangirard/quivr

ai api chatbot chatgpt database docker frontend groq html javascript llm openai postgresql privacy rag react rest-api security typescript vector

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/stangirard/quivr
Owner: QuivrHQ
License: apache-2.0
Created: 2023-05-12T23:53:30.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-12T17:23:51.000Z (7 months ago)
Last Synced: 2024-04-14T00:25:59.846Z (7 months ago)
Topics: ai, api, chatbot, chatgpt, database, docker, frontend, groq, html, javascript, llm, openai, postgresql, privacy, rag, react, rest-api, security, typescript, vector
Language: TypeScript
Homepage: https://quivr.app
Size: 53.5 MB
Stars: 31,771
Watchers: 266
Forks: 3,078
Open Issues: 125
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Roadmap: docs/roadmap.mdx

Awesome Lists containing this project

awesome-ChatGPT-repositories - quivr - Dump all your files and thoughts into your GenerativeAI Second Brain and chat with it (Others)

README

# Quivr - Your Second Brain, Empowered by Generative AI

[![Discord Follow](https://dcbadge.vercel.app/api/server/HUpRgp2HG8?style=flat)](https://discord.gg/HUpRgp2HG8)
[![GitHub Repo stars](https://img.shields.io/github/stars/quivrhq/quivr?style=social)](https://github.com/quivrhq/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://docs.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/quivrhq/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5

## Getting Started 🚀

You can deploy Quivr to Porter Cloud with one-click:

If you would like to deploy locally, 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://docs.quivr.app/).

### Prerequisites 📋

Ensure you have the following installed:

- Docker
- Docker Compose

### 60 seconds Installation 💽

You can find the installation video [here](https://www.youtube.com/watch?v=cXBa6dZJN48).

- **Step 0**: Supabase CLI

Follow the instructions [here](https://supabase.com/docs/guides/cli/getting-started) to install the Supabase CLI that is required.

```bash
supabase -v # Check that the installation worked
```

- **Step 1**: Clone the repository:

```bash
git clone https://github.com/quivrhq/quivr.git && cd quivr
```

- **Step 2**: Copy the `.env.example` files

```bash
cp .env.example .env
```

- **Step 3**: Update the `.env` files

```bash
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](https://platform.openai.com/api-keys). 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](https://openai.com/pricing/).

- **Step 4**: Launch the project

```bash
cd backend && supabase start
```
and then
```bash
cd ../
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 `[email protected]` & `admin`. You can access the app at [http://localhost:3000/login](http://localhost:3000/login).

You can access Quivr backend API at [http://localhost:5050/docs](http://localhost:5050/docs)

You can access supabase at [http://localhost:54323](http://localhost:54323)

## Updating Quivr 🚀

- **Step 1**: Pull the latest changes

```bash
git pull
```

- **Step 2**: Update the migration

```bash
supabase migration up
```

## 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/quivrhq/quivr/issues)
- [Open Pull Requests](https://github.com/quivrhq/quivr/pulls)
- [Good First Issues](https://github.com/quivrhq/quivr/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
- [Frontend Issues](https://github.com/quivrhq/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Afrontend)
- [Backend Issues](https://github.com/quivrhq/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Abackend)
- [Translate](https://docs.quivr.app/docs/Developers/contribution/guidelines#translations)

## Partners ❤️

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

## 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=quivrhq/quivr&type=Timeline)](https://star-history.com/#quivrhq/quivr&Timeline)