mirror of
https://github.com/StanGirard/quivr.git
synced 2024-08-16 16:40:40 +03:00
📝 add migrations script to get_started doc (#698)
* 📝 add BACKEND_URL to documentation * 📝 add migrations script to get_started doc * 📝 add BACKEND_URL to documentation * 📝 add Resend API to documentation * 🔥 remove broken link in get_started doc
This commit is contained in:
Zineb El Bachiri
GitHub
parent
bc33528297
commit
cc1d98e9b5
90
README.md
90
README.md
@ -21,7 +21,7 @@ Quivr, your second brain, utilizes the power of GenerativeAI to store and retrie
|
||||
- **Fast and Efficient**: Designed with speed and efficiency at its core. Quivr ensures rapid access to your data.
|
||||
- **Secure**: Your data, your control. Always.
|
||||
- **OS Compatible**: Ubuntu 22 or upper.
|
||||
- **File Compatibility**:
|
||||
- **File Compatibility**:
|
||||
- Text
|
||||
- Markdown
|
||||
- PDF
|
||||
@ -63,78 +63,82 @@ Additionally, you'll need a [Supabase](https://supabase.com/) account for:
|
||||
- **Step 1**: Clone the repository using **one** of these commands:
|
||||
|
||||
- If you don't have an SSH key set up:
|
||||
|
||||
|
||||
```bash
|
||||
git clone https://github.com/StanGirard/Quivr.git && cd Quivr
|
||||
```
|
||||
|
||||
- If you have an SSH key set up or want to add it ([guide here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account))
|
||||
|
||||
|
||||
```bash
|
||||
git clone git@github.com:StanGirard/Quivr.git && cd Quivr
|
||||
```
|
||||
|
||||
- **Step 2**: Use the install helper
|
||||
|
||||
You can use the install_helper.sh script to setup your env files
|
||||
|
||||
```bash
|
||||
brew install gum # Windows (via Scoop) scoop install charm-gum
|
||||
|
||||
chmod +x install_helper.sh
|
||||
./install_helper.sh
|
||||
```
|
||||
You can use the install_helper.sh script to setup your env files
|
||||
|
||||
```bash
|
||||
brew install gum # Windows (via Scoop) scoop install charm-gum
|
||||
|
||||
chmod +x install_helper.sh
|
||||
./install_helper.sh
|
||||
```
|
||||
|
||||
- **Step 2 - Bis**: Copy the `.XXXXX_env` files
|
||||
|
||||
```bash
|
||||
cp .backend_env.example backend/core/.env
|
||||
cp .frontend_env.example frontend/.env
|
||||
```
|
||||
```bash
|
||||
cp .backend_env.example backend/core/.env
|
||||
cp .frontend_env.example frontend/.env
|
||||
```
|
||||
|
||||
- **Step 3**: Update the `backend/core/.env` and `frontend/.env` file
|
||||
- **Step 3**: Update the `backend/core/.env` and `frontend/.env` file
|
||||
|
||||
> _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_
|
||||
|
||||
> _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/core/.env`- It is an advanced feature, please be expert in GCP before trying to use it_
|
||||
|
||||
- [ ] Change variables in `backend/core/.env`
|
||||
- [ ] Change variables in `frontend/.env`
|
||||
> _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_
|
||||
|
||||
> _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/core/.env`- It is an advanced feature, please be expert in GCP before trying to use it_
|
||||
|
||||
- [ ] Change variables in `backend/core/.env`
|
||||
- [ ] Change variables in `frontend/.env`
|
||||
|
||||
- **Step 4**: Run the following migration scripts on the Supabase database via the web interface (SQL Editor -> `New query`)
|
||||
|
||||
Use the `migration.sh` script to run the migration scripts
|
||||
|
||||
```bash
|
||||
chmod +x migration.sh
|
||||
./migration.sh
|
||||
```
|
||||
Use the `migration.sh` script to run the migration scripts
|
||||
|
||||
Choose either create_scripts if it's your first time or migrations if you are updating your database.
|
||||
|
||||
All the scripts can be found in the [scripts](scripts/) folder
|
||||
> _If you come from an old version of Quivr, run the scripts in [migration script](scripts/) to migrate your data to the new version in the order of date_
|
||||
```bash
|
||||
chmod +x migration.sh
|
||||
./migration.sh
|
||||
```
|
||||
|
||||
Choose either create_scripts if it's your first time or migrations if you are updating your database.
|
||||
|
||||
All the scripts can be found in the [scripts](scripts/) folder
|
||||
|
||||
> _If you come from an old version of Quivr, run the scripts in [migration script](scripts/) to migrate your data to the new version in the order of date_
|
||||
|
||||
- **Step 5**: Launch the app
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.yml up --build
|
||||
```
|
||||
```bash
|
||||
docker compose -f docker-compose.yml up --build
|
||||
```
|
||||
|
||||
- **Step 6**: Navigate to `localhost:3000` in your browser
|
||||
|
||||
- **Step 7**: Want to contribute to the project?
|
||||
- **Step 7**: Want to contribute to the project?
|
||||
|
||||
```
|
||||
docker compose -f docker-compose.dev.yml up --build
|
||||
```
|
||||
```
|
||||
docker compose -f docker-compose.dev.yml up --build
|
||||
```
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks go to these wonderful people:
|
||||
<a href="https://github.com/stangirard/quivr/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=stangirard/quivr" />
|
||||
<a href="https://github.com/stangirard/quivr/graphs/ciontributors">
|
||||
<img src="https://contrib.rocks/image?repo=stangirard/quivr" />
|
||||
</a>
|
||||
|
||||
## Contribute 🤝
|
||||
|
||||
@ -25,3 +25,15 @@ To switch to a different brain, simply click on the brain name in the menu and s
|
||||
If you have not chosen a brain, you can assume that any documentation you upload will be added to the default brain.
|
||||
|
||||
**Note: If you are having problems with the chat functionality, try selecting a brain from the menu. The default brain is not always selected automatically and you will need a brain selected to use the chat functionality.**
|
||||
|
||||
## Using Resend API
|
||||
|
||||
We have integrated [Resend](https://resend.com/docs/introduction), an email API for developers, in our application to handle sharing brains with an email invitation.
|
||||
|
||||
Two environment variables have been introduced to handle this integration:
|
||||
|
||||
- RESEND_API_KEY: This is the unique API key provided by Resend for our application. It allows us to communicate with the Resend platform in a secure way.
|
||||
|
||||
- RESEND_EMAIL_ADDRESS: This is the email address we use as the sender address when sending emails through Resend.
|
||||
|
||||
After fetching our Resend API key and email address from environment variables, we use it to send an email via resend.Emails.send method.
|
||||
|
||||
@ -5,7 +5,6 @@ title: Getting Started
|
||||
|
||||
# Intro
|
||||
|
||||
|
||||
Quivr, your second brain, utilizes the power of GenerativeAI to store and retrieve unstructured information. Think of it as Obsidian, but turbocharged with AI capabilities.
|
||||
|
||||
## Key Features 🎯
|
||||
@ -14,7 +13,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.
|
||||
- **Fast and Efficient**: Designed with speed and efficiency at its core. Quivr ensures rapid access to your data.
|
||||
- **Secure**: Your data, your control. Always.
|
||||
- **File Compatibility**:
|
||||
- **File Compatibility**:
|
||||
- Text
|
||||
- Markdown
|
||||
- PDF
|
||||
@ -27,17 +26,13 @@ Quivr, your second brain, utilizes the power of GenerativeAI to store and retrie
|
||||
|
||||
## Demo Highlights 🎥
|
||||
|
||||
### **Demo**:
|
||||
### **Demo**:
|
||||
|
||||
<video width="640" height="480" controls>
|
||||
<source src="https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5" type="video/mp4"/>
|
||||
Your browser does not support the video tag.
|
||||
</video>
|
||||
|
||||
## Demo Highlights 🎥
|
||||
|
||||
https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5
|
||||
|
||||
## Getting Started: 🚀
|
||||
|
||||
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
|
||||
@ -64,12 +59,13 @@ Additionally, you'll need a [Supabase](https://supabase.com/) account for:
|
||||
- **Step 1**: Clone the repository using **one** of these commands:
|
||||
|
||||
- If you don't have an SSH key set up:
|
||||
|
||||
|
||||
```bash
|
||||
git clone https://github.com/StanGirard/Quivr.git && cd Quivr
|
||||
```
|
||||
|
||||
- If you have an SSH key set up or want to add it ([guide here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account))
|
||||
|
||||
|
||||
```bash
|
||||
git clone git@github.com:StanGirard/Quivr.git && cd Quivr
|
||||
```
|
||||
@ -81,22 +77,35 @@ cp .backend_env.example backend/core/.env
|
||||
cp .frontend_env.example frontend/.env
|
||||
```
|
||||
|
||||
- **Step 3**: Update the `backend/core/.env` and `frontend/.env` file
|
||||
- **Step 3**: Update the `backend/core/.env` and `frontend/.env` file
|
||||
|
||||
> _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._
|
||||
|
||||
> _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/core/.env`
|
||||
- [ ] Change variables in `frontend/.env`
|
||||
|
||||
- **Step 4**: Run the following migration scripts on the Supabase database via the web interface (SQL Editor -> `New query`)
|
||||
- **Step 4**: Create your database tables and functions with one of these two options:
|
||||
a. Run the following migration scripts on the Supabase database via the web interface (SQL Editor -> `New query`)
|
||||
|
||||
[Creation Script 1](https://github.com/stangirard/quivr/scripts/tables.sql)
|
||||
|
||||
b. Use the `migration.sh` script to run the migration scripts
|
||||
|
||||
```bash
|
||||
chmod +x migration.sh
|
||||
./migration.sh
|
||||
```
|
||||
|
||||
Choose either create_scripts if it's your first time or migrations if you are updating your database.
|
||||
|
||||
All the scripts can be found in the [scripts](https://github.com/stangirard/quivr/scripts/) folder
|
||||
|
||||
> _If you come from an old version of Quivr, run the scripts in [migration script](https://github.com/stangirard/quivr/scripts/) to migrate your data to the new version in the order of date_
|
||||
|
||||
- **Step 5**: Launch the app
|
||||
@ -107,34 +116,30 @@ docker compose -f docker-compose.yml up --build
|
||||
|
||||
- **Step 6**: Navigate to `localhost:3000` in your browser
|
||||
|
||||
- ** Step 7**: Want to contribute to the project?
|
||||
- **Step 7**: Want to contribute to the project?
|
||||
- **Step 7**: Want to contribute to the project?
|
||||
|
||||
```
|
||||
docker compose -f docker-compose.dev.yml up --build
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks goes to these wonderful people:
|
||||
<a href="https://github.com/stangirard/quivr/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=stangirard/quivr" />
|
||||
<img src="https://contrib.rocks/image?repo=stangirard/quivr" />
|
||||
</a>
|
||||
|
||||
|
||||
## Contribute 🤝
|
||||
|
||||
Got a pull request? Open it, and we'll review it as soon as possible. Check out our project board [here](https://github.com/users/StanGirard/projects/5) to see what we're currently focused on, and feel free to bring your fresh ideas to the table!
|
||||
|
||||
|
||||
- [Open Issues](https://github.com/StanGirard/quivr/issues)
|
||||
- [Open Pull Requests](https://github.com/StanGirard/quivr/pulls)
|
||||
- [Good First Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
|
||||
- [Frontend Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Afrontend)
|
||||
- [Backend Issues](https://github.com/StanGirard/quivr/issues?q=is%3Aopen+is%3Aissue+label%3Abackend)
|
||||
|
||||
|
||||
## License 📄
|
||||
|
||||
This project is licensed under the Apache 2.0 License - see the [LICENSE.md](https://github.com/StanGirard/quivr/LICENSE.md) file for details
|
||||
|
||||
Loading…
Reference in New Issue
Block a user