mirror of
https://github.com/StanGirard/quivr.git
synced 2024-08-17 00:50:37 +03:00
fix(docs): add prerequisites section in step 2 (#1149)
* docs: Add prerequisites section in step 2 * feat: showing errors * docs: specifying the prerequisites directly, stating that it is not necessary to perform further steps --------- Co-authored-by: Zineb El Bachiri <100568984+gozineb@users.noreply.github.com>
This commit is contained in:
parent
a9fdbd51e4
commit
ae7a8ea5ea
15
README.md
15
README.md
@ -4,7 +4,6 @@
|
||||
<img src="./logo.png" alt="Quivr-logo" width="30%" style="border-radius: 50%; padding-bottom: 20px"/>
|
||||
</div>
|
||||
|
||||
|
||||
[![Discord Follow](https://dcbadge.vercel.app/api/server/HUpRgp2HG8?style=flat)](https://discord.gg/HUpRgp2HG8)
|
||||
[![GitHub Repo stars](https://img.shields.io/github/stars/stangirard/quivr?style=social)](https://github.com/stangirard/quivr)
|
||||
[![Twitter Follow](https://img.shields.io/twitter/follow/StanGirard?style=social)](https://twitter.com/_StanGirard)
|
||||
@ -38,7 +37,7 @@ https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-7056
|
||||
|
||||
## Disclaimer ⚠️
|
||||
|
||||
For a little while, Quivr will be only compatible with OpenAI API.
|
||||
For a little while, Quivr will be only compatible with OpenAI API.
|
||||
|
||||
If you want to use a Local LLM please refer to [v0.0.46](https://github.com/StanGirard/quivr/releases/tag/v0.0.46).
|
||||
|
||||
@ -81,17 +80,23 @@ Additionally, you'll need a [Supabase](https://supabase.com/) account for:
|
||||
git clone git@github.com:StanGirard/Quivr.git && cd Quivr
|
||||
```
|
||||
|
||||
- **Step 2**: Use the install helper
|
||||
- **Step 2**: Use the install helper script to automate subsequent steps.
|
||||
You can use the install_helper.sh script to setup your env files and execute the migrations.
|
||||
|
||||
You can use the install_helper.sh script to setup your env files
|
||||
prerequisites:
|
||||
|
||||
```bash
|
||||
brew install gum # Windows (via Scoop) scoop install charm-gum
|
||||
brew install gum # Windows (via Scoop) scoop install charm-gum
|
||||
brew install postgresql # Windows (via Scoop) scoop install postgresql
|
||||
```
|
||||
|
||||
```bash
|
||||
chmod +x install_helper.sh
|
||||
./install_helper.sh
|
||||
```
|
||||
|
||||
If you want to manually set up the environment, follow the steps below, otherwise skip to Step 6.
|
||||
|
||||
- **Step 2 - Bis**: Copy the `.XXXXX_env` files
|
||||
|
||||
```bash
|
||||
|
@ -76,11 +76,11 @@ fi
|
||||
|
||||
# Step 4: Run the migration scripts (this is supposed to be done manually as per the instructions)
|
||||
echo "Running the migration scripts..."
|
||||
./migration.sh
|
||||
./migration.sh || error_exit "Error running migration scripts."
|
||||
|
||||
# Step 5: Launch the app
|
||||
echo "Launching the app..."
|
||||
docker compose up --build
|
||||
docker compose up --build || error_exit "Error running docker compose."
|
||||
|
||||
# Final message
|
||||
echo "Navigate to localhost:3000 in your browser to access the app."
|
||||
|
@ -1,5 +1,8 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Exit script immediately on first error.
|
||||
set -e
|
||||
|
||||
# Function to run SQL file
|
||||
run_sql_file() {
|
||||
local file="$1"
|
||||
|
Loading…
Reference in New Issue
Block a user