Skip to content

docs: add required Supabase initialization steps to Docker setup guide#1676

Open
tamannaa-rath wants to merge 1 commit into
leonagoel:mainfrom
tamannaa-rath:docs/update-docker-setup
Open

docs: add required Supabase initialization steps to Docker setup guide#1676
tamannaa-rath wants to merge 1 commit into
leonagoel:mainfrom
tamannaa-rath:docs/update-docker-setup

Conversation

@tamannaa-rath

@tamannaa-rath tamannaa-rath commented Jun 15, 2026

Copy link
Copy Markdown

Pull Request Description

This PR updates the Docker Compose setup documentation to include the required Supabase database initialization steps.


Why

Previously, contributors were instructed to configure the environment file and start the application using Docker, but the setup guide did not mention the required database schema creation and product data import process. As a result, contributors could successfully start the frontend and backend containers while product-related functionality remained unavailable due to missing database tables and data.


Related Issue

Closes #1580


What Changed

  • Added Supabase database initialization steps to the Docker Compose setup guide.
  • Documented the required migration scripts for creating application tables.
  • Added instructions for importing product data using scripts/import_to_supabase.py.
  • Included a note explaining that product-related functionality will not work until the schema and data are initialized.

How to Test

  1. Follow the updated setup instructions.
  2. Configure the .env file with valid Supabase credentials.
  3. Run the migration scripts in the Supabase SQL Editor:
    • 001_create_benchmark_runs.sql
    • 002_create_products_table.sql
    • 003_create_feedback_submissions.sql
  4. Import product data:
python scripts/import_to_supabase.py
  1. Start the application:
docker-compose up --build
  1. Verify that:
    • The application starts successfully.
    • Product data is available.
    • Product-related endpoints function correctly.

@github-actions

Copy link
Copy Markdown

🎉 Welcome to Hybrid Recommender, @tamannaa-rath! This is your first contribution here!

Labels added: gssoc:approved | mentor:leonagoel | status:review-needed

PR Description Checklist:

NO - What changed section
NO - Why section
NO - How to test section
YES - Related issue linked

⚠️ Some required sections are missing. Please update your PR description.

What happens next:

  1. @leonagoel will review your changes
  2. CI checks must pass
  3. Once approved, this PR will be auto-merged

⏱️ Please respond to review comments within 48 hours.

@github-actions

Copy link
Copy Markdown

🎉 Welcome to Hybrid Recommender, @tamannaa-rath!

Thank you for your first pull request! Here's what happens next:

Step What Who
1 CI runs lint + smoke test 🤖 Automated
2 Code review 👤 @leonagoel
3 mentor:leonagoel label added 👤 Mentor
4 gssoc:approved label added 👤 Mentor
5 Auto-merge triggered 🤖 Automated
6 Points on leaderboard at 4 AM IST 🏆 GSSoC

⏱️ Please respond to any review comments within 48 hours.

📖 Resources:

Happy contributing! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: README.md and SETUP.md sections related to Docker Compose setup and contributor onboarding.

1 participant