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
Go to file
Stan Girard 9e0bc0749f
feat: 🎸 install (#1784)
now made easy

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

## Checklist before requesting a review

Please delete options that are not relevant.

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged

## Screenshots (if appropriate):
2023-12-02 14:50:57 +01:00
.aws fix(aws): fixed cpu 1 2023-09-21 11:26:58 +02:00
.github test(contact): added contact route with mock 2023-11-13 17:58:11 +01:00
.idea improve (importing): reorganization of the import structure (#964) 2023-08-21 12:25:16 +02:00
.vscode refactor: knowledge module (#1743) 2023-11-29 09:04:03 +01:00
backend feat: 🎸 install (#1784) 2023-12-02 14:50:57 +01:00
cms/quivr feat: add remote notification config (#1547) 2023-11-02 19:20:07 +01:00
connectors/telegram_bot feat: 🎸 telegram (#1559) 2023-11-02 09:38:07 +01:00
docs feat(install): it now takes 30 seconds to install Quivr (#1780) 2023-12-02 00:26:06 +01:00
frontend feat(install): it now takes 30 seconds to install Quivr (#1780) 2023-12-02 00:26:06 +01:00
scripts feat(install): it now takes 30 seconds to install Quivr (#1780) 2023-12-02 00:26:06 +01:00
volumes feat(install): it now takes 30 seconds to install Quivr (#1780) 2023-12-02 00:26:06 +01:00
.env.example feat: 🎸 install (#1784) 2023-12-02 14:50:57 +01:00
.flake8 Feat: chat name edit (#343) 2023-06-20 09:54:23 +02:00
.gitignore feat(install): it now takes 30 seconds to install Quivr (#1780) 2023-12-02 00:26:06 +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.125 (#1760) 2023-11-30 10:37:52 +01:00
docker-compose.dev.yml feat: 🎸 marketplace (#1657) 2023-11-19 18:46:12 +01:00
docker-compose.yml feat: 🎸 install (#1784) 2023-12-02 14:50:57 +01: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 ci(renovate): removed 2023-11-20 17:49:33 +01:00
migration.sh fix(migration): fixed incorrect key 2023-12-01 22:48:02 +01:00
README.md feat: 🎸 install (#1784) 2023-12-02 14:50:57 +01:00
vercel.json Feat/preview env (#399) 2023-06-29 09:55:06 +02:00

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 💽

  • Step 1: Clone the repository using one of these commands:

    • If you don't have an SSH key set up:
    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)
    git clone git@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.

    Want to use Ollama.ai instead, in order to do so, follow the instructions here.

  • Step 4: Launch the project

    docker compose pull 
    docker compose up --build
    
  • Step 5: Login to the app

You can now sign in to the app with your new user. You can access the app at http://localhost:3000/login. Email: admin@quivr.app Password: admin

You can also connect to the supabase database at http://localhost:8080 with the following credentials: admin/admin in order to create new users.

You can access Quivr backend API at http://localhost:5050/

Updating Quivr 🚀

  • Step 1: Pull the latest changes

    git pull
    
  • 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 -> Run)

    All the scripts can be found in the scripts folder

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!

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 file for details

Stars History 📈

Star History Chart