[Bug]: README Quick Start and documentation outdated

arya-coding commented 10 months ago

What happened?

Hello Quivr,

I was initially excited to discover and try out Quivr. However, after a few days of trying to make it work locally with ollama, I realized that the README of this repository is misleading and outdated.

It does not specify that you have to manually create a user on Supabase.
It does not specific if you need to do a supabase sql migration (I have to guess here)
Additionally, the interface seems to have a hybrid approach now, as it invite you to pay for the PRO option even when running locally.

Furthermore, the website documentation on ollama is also incorrect :

The file paths are not right
The commands specified do not work. Example : look at this please, it's the official Quivr documentation for setting up Ollama, the command is not only useless (mv same file/folder), but also wrong as the file is in a subdirectory called migration :
The quivr ollama docker compose somehow disappeared from the repository

This is a major issue for new users on your platform. As a result, I ended up going for another project on GitHub.

I hope to come back to try out and promote Quivr because so far it has been a lost of time for me.

Relevant log output

No response

Twitter / LinkedIn details

No response

dosubot[bot] commented 10 months ago

🤖

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

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

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.

StanGirard commented 10 months ago

@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.

tinchopu commented 9 months ago

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

tinchopu commented 9 months ago

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" ...

3koozy commented 9 months ago

I can't run quiver as of today due to login and creating users on local supabase issues..

github-actions[bot] commented 6 months ago

Thanks for your contributions, we'll be closing this issue as it has gone stale. Feel free to reopen if you'd like to continue the discussion.

QuivrHQ / quivr