Skip to content

[DOCS] Add some Supabase PostgreSQL setup steps to development setup guide #197

@kyileiaye2021

Description

@kyileiaye2021

Type of documentation issue

Other (please specify in description)

Documentation page URL

https://github.com/Extralit/extralit/blob/develop/extralit/docs/getting_started/development_setup.md

Current content

The development setup guide currently covers Docker/Tilt-based workflows and includes a generic external PostgreSQL configuration example. However, it does not provide a Supabase-specific walkthrough for setting up persistent PostgreSQL (and S3-compatible storage) for first-time contributors, particularly those using GitHub Codespaces.

As a result, contributors may encounter confusion around:

  • Which Supabase connection mode to use (e.g. session pooler vs direct)
  • Common IPv4 / pooler-related connection issues in Codespaces
  • How to verify that the Extralit server is successfully connected to Supabase after ingestion

Suggested fix or improvement

I suggest adding an optional subsection to the development setup guide that outlines how to use Supabase as an external PostgreSQL backend during local development.

This could include high-level guidance such as:

  • Selecting the Session Pooler connection in Supabase when working from IPv4-only environments (e.g. GitHub Codespaces)
  • Example environment variable configuration for connecting Extralit to a Supabase PostgreSQL database
  • Simple steps to verify the connection (e.g. successful ingestion and data visibility in Supabase)

This would help reduce setup friction for new contributors.

User Perspective

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions