Skip to content

Supabase

Leithen edited this page Sep 28, 2024 · 2 revisions

Supabase is a Postgres database and database API used on the Streamability project. This is cloud based for production and run on in a docker container for local development. This document is intended to help developers setup and use the local supabase instance.

Setup πŸ—

Pre-requisites

You will need to install docker on your machine to run the local Supabase server. Follow the installation instruction on the docker website for your specific OS.

Have the project set up with node modules installed. Refer to getting started if necessary.


  1. Ensure docker is running.

  2. Populate the .env file.

  • VITE_SUPABASE_URL
  • VITE_SUPABASE_ANON_KEY

Both keys will be output by the command:

npm run db-start

To have the keys automatically written to you .env file, use the command:

npm run db-start-env

Usage πŸ§‘β€πŸ’»

To start the local Supabase instance, use the command:

npm run db-start

This will start the Supabse instace and launch the GUI on localhost:54323.


To stop the local Supabase instance, use the command:

npm run db-stop

Other Documents πŸ“„

[How To] Delete the profile table

Clone this wiki locally