[Bug]: README Quick Start and documentation outdated about quivr HOT 4 OPEN

🤖

Hey @arya-coding, great to see you back! Looks like we've got some adventures to tackle together again. 😄

I'm sorry to hear about the difficulties you've encountered while setting up Quivr. I understand how frustrating it can be when the documentation is not up-to-date or clear.

Based on your feedback, I've drafted an updated version of the README.md file that includes more detailed instructions on the setup process, including creating a user on Supabase and conducting a Supabase SQL migration.

Here's the updated README.md file:

## 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://docs.quivr.app/).

### Prerequisites 📋

Ensure you have the following installed:

- Docker
- Docker Compose
- Supabase CLI

### Setup Process 💽

- **Step 0**: Create a user on Supabase

  Follow the instructions [here](https://supabase.com/docs/guides/auth#signing-up) to create a user on Supabase.

- **Step 1**: Conduct a Supabase SQL migration

  Follow the instructions [here](https://supabase.com/docs/guides/database/migrations) to conduct a Supabase SQL migration.

- **Step 2**: Clone the repository:

  ```bash
  git clone https://github.com/StanGirard/Quivr.git && cd Quivr

• Step 3: Copy the .env.example files

  cp .env.example .env

• Step 4: 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 5: 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 6: 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.

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

  You can access supabase at http://localhost:54323

I hope this updated README.md file will help you and other users to set up Quivr more easily. 

As for the issue with the Quivr ollama docker compose disappearing from the repository, I'm unable to provide a solution as I don't have the ability to create pull requests or issues. However, I recommend reaching out to the repository maintainers directly for further assistance.

I appreciate your feedback and patience. Your input helps improve Quivr for everyone.

## Sources
- [README.md](https://github.com/StanGirard/quivr/blob/main/README.md)

---

This response is meant to be useful and save you time. It is **not meant to be a precise solution**, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

from quivr.

@dosu-bot the link provided in Step 1 https://supabase.com/docs/guides/database/migrations returns a 404

from quivr.

@arya-coding Thanks a lot for your feedback.

I'm wondering which version of Quivr you have as we have updated the installation of quivr to make it very simple with Ollama.

Did you follow the new readme ?

I'm sorry to hear that you don't like the project. Please feel free to open a PR to help us improve this entirely open-source project.

from quivr.

Ok I made it work locally. In step 5 you need to "cd supabase" and from there run "supabase start". Then "cd .." and from there continue with "docker compose pull" ...

from quivr.