QuivrHQ/quivr
1
1
Fork 0
mirror of https://github.com/QuivrHQ/quivr.git synced 2024-08-17 02:10:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add clarification on Project API keys and web interface for migration scripts to Readme (#58)

Browse Source
This commit is contained in:
Matt LeBel 2023-05-18 18:44:09 -04:00 committed by GitHub
parent 987d15e669
commit 97777f8c39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -39,14 +39,17 @@ These instructions will get you a copy of the project up and running on your loc
### Prerequisites
What things you need to install the software and how to install them.
Make sure you have the following installed before continuing:
- Python 3.10 or higher
- Pip
- Virtualenv
- Supabase account
- Supabase API key
- Supabase URL
You'll also need a [Supabase](https://supabase.com/) account for:
- A new Supabase project
- Supabase Project API key
- Supabase Project URL
### Installing
@ -89,7 +92,9 @@ openai_api_key = "OPENAI_API_KEY"
anthropic_api_key = "ANTHROPIC_API_KEY" # Optional
```
- Run the migration script on the Supabase database via the web interface
_Note that the `supabase_service_key` is found in your Supabase dashboard under Project Settings -> API. Use the `anon` `public` key found in the `Project API keys` section._
- Run the following migration scripts on the Supabase database via the web interface (SQL Editor -> `New query`)
```sql
-- Enable the pgvector extension to work with embedding vectors