StanGirard/quivr
1
1
Fork 0
mirror of https://github.com/StanGirard/quivr.git synced 2024-11-30 01:32:52 +03:00
Code Issues Packages Projects Releases Wiki Activity
🧠 Dump all your files and chat with it using your Generative AI Second Brain using LLMs ( GPT 3.5/4, Private, Anthropic, VertexAI ) & Embeddings 🧠
1,309 Commits 835 Branches 346 Tags 202 MiB
Python 99.2%
Shell 0.8%
64ba190d6c
Go to file
Stan Girard 64ba190d6c
chore(main): release 0.0.184 (#2089) 
🤖 I have created a release *beep* *boop*
---


## 0.0.184 (2024-01-26)

## What's Changed
* feat(panel): added by @Zewed in
https://github.com/StanGirard/quivr/pull/2088
* feat: 🎸 api by @StanGirard in
https://github.com/StanGirard/quivr/pull/2078
* fix(frontend): clear message input on submit by @Zewed in
https://github.com/StanGirard/quivr/pull/2087
* fix: 🐛 related by @StanGirard in
https://github.com/StanGirard/quivr/pull/2090
* feat: Added translation status badge from inlang by @NilsJacobsen in
https://github.com/StanGirard/quivr/pull/2080
* fix(streaming): Data Truncation Issue in useHandleStream Function by
@openperf in https://github.com/StanGirard/quivr/pull/2079
* feat: 🎸 sources by @StanGirard in
https://github.com/StanGirard/quivr/pull/2092
* fix(frontend): clean related Brains useEffect by @Zewed in
https://github.com/StanGirard/quivr/pull/2091

## New Contributors
* @openperf made their first contribution in
https://github.com/StanGirard/quivr/pull/2079

**Full Changelog**:
https://github.com/StanGirard/quivr/compare/v0.0.183...v0.0.184

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
2024-01-25 22:15:39 -08:00
.aws feat: 🎸 cpu (#2065) 2024-01-22 15:02:00 -08:00
.github chore(deps): pin dependencies (#1975) 2024-01-04 14:00:18 +01:00
.idea improve (importing): reorganization of the import structure (#964) 2023-08-21 12:25:16 +02:00
.vscode feat: 🎸 supabase 2024-01-03 21:53:37 +01:00
backend fix: 🐛 public-brains 2024-01-25 22:02:48 -08:00
cms/quivr chore(deps): Pin dependencies (#1953) 2024-01-03 12:01:20 +01:00
connectors/telegram_bot feat: 🎸 telegram (#1559) 2023-11-02 09:38:07 +01:00
docs feat: Added translation status badge from inlang (#2080) 2024-01-25 17:59:16 -08:00
frontend fix: 🐛 build 2024-01-25 22:08:49 -08:00
project.inlang chore: add IDE extension for i18n handling (#1896) 2023-12-14 16:00:22 +01:00
scripts/quivr_team_only feat: 🎸 supabase 2024-01-07 16:50:38 +01:00
supabase feat: 🎸 api (#2078) 2024-01-25 15:56:46 -08:00
volumes feat(install): it now takes 30 seconds to install Quivr (#1780) 2023-12-02 00:26:06 +01:00
.env.example feat: 🎸 supabase 2024-01-07 16:50:38 +01:00
.flake8 Feat: chat name edit (#343) 2023-06-20 09:54:23 +02:00
.gitignore feat: 🎸 api (#2078) 2024-01-25 15:56:46 -08:00
.gitmodules Add submodule for frontend/app/platform 2023-12-13 00:59:11 +01:00
.migration_info feat(install): it now takes 30 seconds to install Quivr (#1780) 2023-12-02 00:26:06 +01:00
CHANGELOG.md chore(main): release 0.0.184 (#2089) 2024-01-25 22:15:39 -08:00
docker-compose.dev.yml chore(docker): increased number of replicas 2024-01-20 13:51:03 -08:00
docker-compose.yml chore(docker): increased number of replicas 2024-01-20 13:51:03 -08:00
LICENSE feat(license): added 2023-05-13 18:12:35 +02:00
logo.png docs(readme): making it nice (#102) 2023-05-21 14:53:47 +02:00
Makefile feat: Update pytest command in Makefile and add new test (#1893) 2023-12-14 14:20:34 +01:00
migration.sh fix(migration): fixed incorrect key 2023-12-01 22:48:02 +01:00
README.md feat: 🎸 supabase 2024-01-13 22:40:27 -08:00
renovate.json chore: 🤖 renovate 2024-01-04 13:05:45 +01:00
vercel.json Revert "feat: 🎸 posthog (#1945)" 2024-01-02 10:23:40 +01:00

README.md

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 be your personal assistant ! Think of it as Obsidian, but turbocharged with AI capabilities.

Roadmap here

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.

Prerequisites 📋

Ensure you have the following installed:

  • Docker
  • Docker Compose

60 seconds Installation 💽

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/StanGirard/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

Updating Quivr 🚀

  • Step 1: Pull the latest changes

    git pull

  • Step 2: Update the migration

    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 to see what we're currently focused on, and feel free to bring your fresh ideas to the table!

Partners ❤️

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

Theodo

License 📄

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

Stars History 📈

Star History Chart