omegabridge/gqlbridge-editor repository overview

⁠GraphQL Dynamic Editor — Docker Setup Guide

⁠📘 Overview

This Docker image runs a live GraphQL editor (Apollo Server + GraphiQL UI) that automatically reloads whenever the GraphQL schema file updates — that supports schemas generated from gqlbridge (Flask-based backend).

A Python script (generate_schema.py) runs during container startup to generate the initial schema, and the Node.js server continuously watches for schema changes.
It can also proxy requests to a remote GraphQL endpoint (e.g., a Flask backend).

⁠🏗️ Directory Structure

graphql-dynamic-editor/ │ ├── Dockerfile ├── package.json ├── server.js # Apollo + GraphiQL server with live reload & remote proxy support ├── generate_schema.py # Python script to generate /app/schema.graphql ├── schema.graphql # GraphQL schema (auto-updated) ├── .env # Environment variables for DB & endpoint config ├── alias.yml # Defines aliases for columns, tables, and schemas

⁠🌍 Example .env File

POSTGRES_USER=admin
POSTGRES_PASSWORD=secret
POSTGRES_DB=mydb
POSTGRES_HOST=my-postgres
POSTGRES_PORT=5432

# Remote GraphQL endpoint (Flask backend)
GRAPHQL_ENDPOINT=http://host.docker.internal:5000/graphql-query

# Optional authentication token (if required)
GRAPHQL_TOKEN=<Token>

⁠🌍 Example alias.yml File

tables:
  public: # Schema name
    epics: # Table name under the above schema
      table_name: epic # Rename the table (optional)
      schema_name: test # Rename the schema of above mentioned table (optional)
      old_col: yaml # Rename a column: old_column_name: new_column_name

⁠🚀 Run the Container

sudo docker run -d \
  --name graphql-editor \
  --env-file .env \
  -v alias.yml:/app/alias.yml \
  -p 4000:4000 \
  graphql-dynamic-editor

| 🧩 The --env-file .env flag passes environment variables into the container.

⁠🧠 How It Works

⁠🧾 Example Log Flow

• 🐍 Running Python schema generator...
• ✅ Schema written to /app/schema.graphql
• 🚀 GraphQL Editor running at http://localhost:4000/⁠
• 🔄 Schema file updated — reloading Apollo Server...

⁠✅ Summary

• 🐍 Automatically generates schema at container startup
• 🚀 Reflects live updates in the GraphiQL UI
• 🔄 Supports remote GraphQL proxying (Flask backend)
• 🔐 Optional authentication token support
• 🧩 Clean Node + Python hybrid setup
• ⚙️ Single-step run — no manual reloads or cron jobs required
• ⚠️ Exception: The editor does not currently support JSON column types.