mirror of
https://github.com/StanGirard/quivr.git
synced 2024-12-02 08:40:53 +03:00
3b494c807f
This pull request introduces comprehensive documentation for configuring Supabase in Quivr, including details on CLI usage, running migrations, resetting the database, and deploying to a hosted version of Supabase. - **Documentation Addition**: Adds a new document `docs/configuring/supabase-setup.mdx` that provides a step-by-step guide on setting up Supabase for Quivr. This includes initializing Supabase, configuring environment variables, using the Supabase CLI for migrations and database resets, and deploying to a hosted Supabase environment. - **Documentation Navigation Update**: Updates `docs/mint.json` to include a reference to the newly added `supabase-setup.mdx` in the configuring section, ensuring users can easily find this resource. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/QuivrHQ/quivr?shareId=cadcc1b3-ff9d-4650-b92a-28cadcc3ebdf).
69 lines
1.4 KiB
Plaintext
69 lines
1.4 KiB
Plaintext
---
|
|
title: Supabase
|
|
description: Comprehensive guide on setting up Supabase for Quivr, including CLI usage, migrations, database reset, and deployment.
|
|
---
|
|
|
|
# Configuring Supabase in Quivr
|
|
|
|
This document provides a comprehensive guide on how to configure Supabase in Quivr, detailing CLI usage, running migrations, resetting the database, and deploying to a hosted version of Supabase.
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, ensure you have the following:
|
|
|
|
- A Supabase account
|
|
- The Supabase CLI installed on your machine
|
|
|
|
## Setting Up Supabase
|
|
|
|
### 1. Initialize Supabase
|
|
|
|
To start, initialize a new Supabase project:
|
|
|
|
```bash
|
|
supabase init
|
|
```
|
|
|
|
### 2. Configure Environment Variables
|
|
|
|
Set up the necessary environment variables in your `.env` file:
|
|
|
|
```plaintext
|
|
SUPABASE_URL=your_supabase_url
|
|
SUPABASE_SERVICE_KEY=your_service_key
|
|
```
|
|
|
|
## Using the Supabase CLI
|
|
|
|
### Running Migrations
|
|
|
|
To run migrations on your Supabase project:
|
|
|
|
```bash
|
|
supabase db push
|
|
```
|
|
|
|
### Resetting the Database
|
|
|
|
If you need to reset your database:
|
|
|
|
```bash
|
|
supabase db reset
|
|
```
|
|
|
|
## Deploying to Hosted Supabase
|
|
|
|
To deploy your Quivr configurations to a hosted version of Supabase:
|
|
|
|
1. Commit your changes to your project repository.
|
|
2. Use the Supabase CLI to push your changes:
|
|
|
|
```bash
|
|
supabase db push --linked
|
|
```
|
|
|
|
## Conclusion
|
|
|
|
By following these steps, you can successfully configure Supabase in Quivr, making use of its powerful database and backend services to enhance your project.
|
|
|