StanGirard/quivr
1
1
Fork 0
mirror of https://github.com/StanGirard/quivr.git synced 2024-11-26 12:55:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve readme.md (#1511)

Browse Source 
# Description

Done some enhancement to the `README.md` file.

- Add blank space after `JWT_SECRET_KEY`
- **OS Compatible**: Ubuntu 22 or upper. -> **OS Compatible**: Ubuntu 22
or newer.
- Remove checkbox and add sublist instead.
```
- [ ] Change variables in `backend/.env`    to   - Change variables in `backend/.env`
- [ ] Change variables in `frontend/.env`    to   - Change variables in `frontend/.env`
```
This commit is contained in:
Ankur Singh 2023-10-27 13:08:44 +05:30 committed by GitHub
parent f810d8fbf3
commit 1fe10d904d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -18,7 +18,7 @@ Quivr, your second brain, utilizes the power of GenerativeAI to store and retrie
- **Generative AI**: Quivr employs advanced AI to assist you in generating and retrieving information. - **Generative AI**: Quivr employs advanced AI to assist you in generating and retrieving information.
- **Fast and Efficient**: Designed with speed and efficiency at its core. Quivr ensures rapid access to your data. - **Fast and Efficient**: Designed with speed and efficiency at its core. Quivr ensures rapid access to your data.
- **Secure**: Your data, your control. Always. - **Secure**: Your data, your control. Always.
- **OS Compatible**: Ubuntu 22 or upper. - **OS Compatible**: Ubuntu 22 or newer.
- **File Compatibility**: - **File Compatibility**:
- Text - Text
- Markdown - Markdown
@ -108,14 +108,14 @@ Additionally, you'll need a [Supabase](https://supabase.com/) account for:
> _Your `supabase_service_key` can be found in your Supabase dashboard under Project Settings -> API. Use the `anon` `public` key found in the `Project API keys` section._ > _Your `supabase_service_key` can be found in your Supabase dashboard under Project Settings -> API. Use the `anon` `public` key found in the `Project API keys` section._
> _Your `JWT_SECRET_KEY`can be found in your supabase settings under Project Settings -> API -> JWT Settings -> JWT Secret_ > _Your `JWT_SECRET_KEY` can be found in your supabase settings under Project Settings -> API -> JWT Settings -> JWT Secret_
> _The `NEXT_PUBLIC_BACKEND_URL` is set to localhost:5050 for the docker. Update it if you are running the backend on a different machine._ > _The `NEXT_PUBLIC_BACKEND_URL` is set to localhost:5050 for the docker. Update it if you are running the backend on a different machine._
> _To activate vertexAI with PaLM from GCP follow the instructions [here](https://python.langchain.com/en/latest/modules/models/llms/integrations/google_vertex_ai_palm.html) and update `backend/.env`- It is an advanced feature, please be expert in GCP before trying to use it_ > _To activate vertexAI with PaLM from GCP follow the instructions [here](https://python.langchain.com/en/latest/modules/models/llms/integrations/google_vertex_ai_palm.html) and update `backend/.env`- It is an advanced feature, please be expert in GCP before trying to use it_
- [ ] Change variables in `backend/.env` - Change variables in `backend/.env`
- [ ] Change variables in `frontend/.env` - Change variables in `frontend/.env`
- **Step 4**: Use the `migration.sh` script to run the migration scripts - **Step 4**: Use the `migration.sh` script to run the migration scripts