### Install and Start Test Client Source: https://github.com/apache/superset/blob/master/superset-websocket/utils/client-ws-app/README.md Navigate to the client application directory, install its dependencies, and start the client. ```bash cd client-ws-app npm install npm start ``` -------------------------------- ### Flask Server Setup and Initialization Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/development-setup.md Steps to set up a virtual environment, install dependencies, initialize the database, create an admin user, and start the Flask development server. ```bash # Create a virtual environment and activate it (recommended) python3 -m venv venv # setup a python3 virtualenv source venv/bin/activate # Install external dependencies pip install -r requirements/development.txt # Install Superset in editable (development) mode pip install -e . # Initialize the database superset db upgrade # Create an admin user in your metadata database (use `admin` as username to be able to load the examples) superset fab create-admin # Create default roles and permissions superset init # Load some data to play with. # Note: you MUST have previously created an admin user with the username `admin` for this command to work. superset load-examples # Start the Flask dev web server from inside your virtualenv. # Note that your page may not have CSS at this point. # See instructions below on how to build the front-end assets. superset run -p 8088 --with-threads --reload --debugger --debug ``` -------------------------------- ### Start Superset Webserver and Frontend (Manual Setup) Source: https://github.com/apache/superset/blob/master/superset/mcp_service/README.md Instructions to start the Superset webserver in one terminal and the frontend development server in another. ```bash # 7. Start Superset (in one terminal) superset run -p 9001 --with-threads --reload --debugger # 8. Start frontend (in another terminal) cd superset-frontend && npm run dev ``` -------------------------------- ### Set up Python Environment and Install Dependencies (Manual Setup) Source: https://github.com/apache/superset/blob/master/superset/mcp_service/README.md Create a virtual environment and install the necessary Python dependencies for Superset development, including the fastMCP protocol. ```bash python3 -m venv venv source venv/bin/activate pip install -e .[development,fastmcp] cd superset-frontend && npm ci && npm run build && cd .. ``` -------------------------------- ### Install Dependencies and Start Local Docs Server Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/howtos.md Navigate to the docs directory, install npm dependencies, and start the Docusaurus development server to preview documentation changes locally. ```bash cd docs npm install npm run start ``` -------------------------------- ### Makefile Installation for Development Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/development-setup.md Alternative method to install development dependencies and setup the environment using the Makefile. ```bash # Create a virtual environment and activate it (recommended) $ python3 -m venv venv # setup a python3 virtualenv $ source venv/bin/activate # install pip packages + pre-commit $ make install # Install superset pip packages and setup env only $ make superset # Setup pre-commit only $ make pre-commit ``` -------------------------------- ### Example Pip Installation Output Source: https://github.com/apache/superset/blob/master/superset-frontend/plugins/legacy-plugin-chart-country-map/scripts/Country Map GeoJSON Generator.ipynb This output indicates that the specified Python packages are already installed and up to date. It also provides warnings about running pip as root and suggests using a virtual environment. ```text Requirement already satisfied: geopandas in /usr/local/lib/python3.11/site-packages (1.1.3)\nRequirement already satisfied: shapely in /usr/local/lib/python3.11/site-packages (2.1.2)\nRequirement already satisfied: matplotlib in /usr/local/lib/python3.11/site-packages (3.11.0)\nRequirement already satisfied: requests in /usr/local/lib/python3.11/site-packages (2.34.2)\nRequirement already satisfied: numpy>=1.24 in /usr/local/lib/python3.11/site-packages (from geopandas) (2.4.6)\nRequirement already satisfied: pyogrio>=0.7.2 in /usr/local/lib/python3.11/site-packages (from geopandas) (0.12.1)\nRequirement already satisfied: packaging in /root/.local/lib/python3.11/site-packages (from geopandas) (26.2)\nRequirement already satisfied: pandas>=2.0.0 in /usr/local/lib/python3.11/site-packages (from geopandas) (3.0.3)\nRequirement already satisfied: pyproj>=3.5.0 in /usr/local/lib/python3.11/site-packages (from geopandas) (3.7.2)\nRequirement already satisfied: contourpy>=1.0.1 in /usr/local/lib/python3.11/site-packages (from matplotlib) (1.3.3)\nRequirement already satisfied: cycler>=0.10 in /usr/local/lib/python3.11/site-packages (from matplotlib) (0.12.1)\nRequirement already satisfied: fonttools>=4.22.0 in /usr/local/lib/python3.11/site-packages (from matplotlib) (4.63.0)\nRequirement already satisfied: kiwisolver>=1.3.1 in /usr/local/lib/python3.11/site-packages (from matplotlib) (1.5.0)\nRequirement already satisfied: pillow>=9 in /usr/local/lib/python3.11/site-packages (from matplotlib) (12.2.0)\nRequirement already satisfied: pyparsing>=3 in /usr/local/lib/python3.11/site-packages (from matplotlib) (3.3.2)\nRequirement already satisfied: python-dateutil>=2.7 in /root/.local/lib/python3.11/site-packages (from matplotlib) (2.9.0.post0)\nRequirement already satisfied: charset_normalizer<4,>=2 in /usr/local/lib/python3.11/site-packages (from requests) (3.4.7)\nRequirement already satisfied: idna<4,>=2.5 in /usr/local/lib/python3.11/site-packages (from requests) (3.18)\nRequirement already satisfied: urllib3<3,>=1.26 in /usr/local/lib/python3.11/site-packages (from requests) (2.7.0)\nRequirement already satisfied: certifi>=2023.5.7 in /usr/local/lib/python3.11/site-packages (from requests) (2026.6.17)\nRequirement already satisfied: six>=1.5 in /root/.local/lib/python3.11/site-packages (from python-dateutil>=2.7->matplotlib) (1.17.0)\n\u00133mWARNING: Running pip as the 'root' user can result in broken permissions and conflicting behaviour with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv\u00133m\n\u00131m[\u00134;49mnotice\u00130m\u00131;39;49m]\u001339;49m A new release of pip is available: \u001331;49m24.0\u001339;49m -> \u001332;49m26.1.2\u001339;49m\n\u00131m[\u00134;49mnotice\u00130m\u00131;39;49m]\u001339;49m To update, run: \u001332;49mpip install --upgrade pip\u001339;49m\nNote: you may need to restart the kernel to use updated packages.\n ``` -------------------------------- ### Start MCP Service (Manual Setup) Source: https://github.com/apache/superset/blob/master/superset/mcp_service/README.md Command to start the MCP service in a separate terminal after activating the Python virtual environment. ```bash source venv/bin/activate superset mcp run --port 5008 --debug ``` -------------------------------- ### Install Frontend Dependencies Source: https://github.com/apache/superset/blob/master/docs/developer_docs/extensions/quick-start.md Navigate to the frontend directory and install necessary npm packages. ```bash cd frontend npm install cd .. ``` -------------------------------- ### Start Superset Services with Make Source: https://github.com/apache/superset/blob/master/docker/README.md Use the `make up` command to start Superset services. This command automatically generates a unique project name, finds available ports, and displays the assigned URLs before starting the services. ```bash make up ``` -------------------------------- ### Install apache-superset-core Source: https://github.com/apache/superset/blob/master/superset-core/README.md Install the package using pip. ```bash pip install apache-superset-core ``` -------------------------------- ### Install Python Packages Source: https://github.com/apache/superset/blob/master/superset/mcp_service/PRODUCTION.md Commands to set up a virtual environment and install Superset with MCP support. ```bash # Create virtual environment python3.11 -m venv /opt/superset/venv source /opt/superset/venv/bin/activate # Install Superset with MCP support pip install apache-superset[fastmcp] # Or from requirements.txt pip install -r requirements/production.txt ``` -------------------------------- ### Clone and Start Superset with MCP (Docker) Source: https://github.com/apache/superset/blob/master/superset/mcp_service/README.md Use this command to clone the Superset repository and start Superset with the MCP service using Docker Compose. Ensure Docker and Docker Compose are installed. ```bash git clone https://github.com/apache/superset.git cd superset docker-compose -f docker-compose-light.yml --profile mcp build docker-compose -f docker-compose-light.yml --profile mcp up -d ``` -------------------------------- ### Install Frontend Dependencies Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/development-setup.md Navigate to the `superset-frontend` directory and run this command to install all third-party dependencies listed in `package.json`. ```bash # From the root of the repository cd superset-frontend # Install dependencies from `package-lock.json` npm ci ``` -------------------------------- ### Example Chart API Request Source: https://github.com/apache/superset/blob/master/docs/DOCS_CLAUDE.md Demonstrates how to make a GET request to the Chart API to retrieve a list of charts. Replace YOUR_ACCESS_TOKEN with a valid token. ```bash curl -X GET "http://localhost:8088/api/v1/chart/" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` -------------------------------- ### Install @apache-superset/core Source: https://github.com/apache/superset/blob/master/superset-frontend/packages/superset-core/README.md Use npm to install the core package as a dependency for your extension. ```bash npm install @apache-superset/core ``` -------------------------------- ### Example Data Loading Directory Structure Source: https://github.com/apache/superset/blob/master/UPDATING.md Illustrates the new organization for example data and configurations, promoting self-contained examples with co-located data, metadata, and optional dashboard/chart configurations. ```text superset/examples/ ├── _shared/ # Shared database & metadata configs ├── birth_names/ # Each example is self-contained │ ├── data.parquet # Dataset (Parquet format) │ ├── dataset.yaml # Dataset metadata │ ├── dashboard.yaml # Dashboard config (optional) │ └── charts/ # Chart configs (optional) └── ... ``` -------------------------------- ### Install and Run Flower Source: https://github.com/apache/superset/blob/master/docs/admin_docs/configuration/async-queries-celery.mdx Commands to install and launch the Flower monitoring tool for Celery. ```bash pip install flower ``` ```bash celery --app=superset.tasks.celery_app:app flower ``` -------------------------------- ### Install boto3 Library Source: https://github.com/apache/superset/blob/master/docs/admin_docs/configuration/aws-iam.mdx Ensure the `boto3` library is installed in your Superset environment to interact with AWS services. ```bash pip install boto3 ``` -------------------------------- ### Install Apache Superset Package Source: https://github.com/apache/superset/blob/master/docs/admin_docs/installation/pypi.mdx Install the `apache_superset` package using pip after activating your virtual environment. ```bash pip install apache_superset ``` -------------------------------- ### Initialize Database and Create Admin User (Manual Setup) Source: https://github.com/apache/superset/blob/master/superset/mcp_service/README.md Commands to upgrade the Superset database schema and create an administrator account for manual setup. ```bash export FLASK_APP=superset superset db upgrade superset fab create-admin \ --username admin \ --firstname Admin \ --lastname Admin \ --email admin@localhost \ --password admin ``` -------------------------------- ### Build and Serve Production Documentation Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/howtos.md Create a production build of the documentation site and then serve it locally to test the build before deployment. ```bash npm run build npm run serve ``` -------------------------------- ### Create Admin User, Load Examples, and Initialize Superset Source: https://github.com/apache/superset/blob/master/docs/admin_docs/installation/pypi.mdx Commands to create an admin user, load example data, and initialize Superset's default roles and permissions. ```bash superset fab create-admin superset load_examples superset init ``` -------------------------------- ### Set Up Virtual Environment and Install Dependencies Source: https://github.com/apache/superset/blob/master/RELEASING/README.md Creates a Python virtual environment, activates it, and installs necessary build dependencies including base requirements, build, and twine. This is a prerequisite for building the distribution. ```bash cd ${SUPERSET_RELEASE_RC} python3 -m venv venv source venv/bin/activate pip install -r requirements/base.txt pip install build twine ``` -------------------------------- ### Type Hints - Get Dashboards Source: https://github.com/apache/superset/blob/master/docs/developer_docs/guidelines/backend-style-guidelines.md Example function demonstrating the use of type hints for retrieving dashboards by owner ID. ```APIDOC ## Function: get_dashboards_by_owner ### Description Retrieves all dashboards owned by a specific user. ### Parameters - **owner_id** (int) - The ID of the owner. ### Returns - List[Dashboard] - A list of Dashboard objects. ``` -------------------------------- ### Configure OAuth Provider Source: https://github.com/apache/superset/blob/master/docs/admin_docs/configuration/configuring-superset.mdx Define an OAuth provider in Superset's configuration. This example shows basic setup for 'egaSSO'. ```python OAUTH_PROVIDERS = [ { 'name':'egaSSO', 'token_key':'access_token', # Name of the token in the response of access_token_url 'icon':'fa-address-card', # Icon for the provider 'remote_app': { 'client_id':'myClientId', # Client Id (Identify Superset application) 'client_secret':'MySecret', # Secret for this Client Id (Identify Superset application) 'server_metadata_url': 'https://myAuthorizationServer/.well-known/openid-configuration' } } ] ``` -------------------------------- ### Superset Configuration File Example Source: https://github.com/apache/superset/blob/master/docs/DOCS_CLAUDE.md Illustrates common configuration settings for Superset, including database URI, secret key, and feature flags. ```python # Database connection example SQLALCHEMY_DATABASE_URI = 'postgresql://user:password@localhost/superset' # Security configuration SECRET_KEY = 'YOUR_SECRET_KEY_HERE' WTF_CSRF_ENABLED = True # Feature flags FEATURE_FLAGS = { 'ENABLE_TEMPLATE_PROCESSING': True, 'DASHBOARD_NATIVE_FILTERS': True, } ``` -------------------------------- ### Run Superset Locally with Flask Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/development-setup.md Starts the Flask development server for Superset on port 8088. Ensure Superset and its dependencies are installed and your virtual environment is activated. ```bash superset run -p 8088 --with-threads --reload --debugger --debug ``` -------------------------------- ### Development and Build Commands Source: https://github.com/apache/superset/blob/master/docs/DOCS_CLAUDE.md Commands for starting the development server, building the production site, and serving it locally. ```bash yarn start # Start dev server on http://localhost:3000 yarn stop # Stop running dev server yarn build # Build production site yarn serve # Serve built site locally ``` -------------------------------- ### Internal Linking Strategies Source: https://github.com/apache/superset/blob/master/docs/DOCS_CLAUDE.md Provides examples of creating internal links within documentation using relative paths for navigation between different guides and configuration files. ```markdown [Installation Guide](./installation/docker-compose) [Configuration](../configuration/configuring-superset) ``` -------------------------------- ### Add PostgreSQL Driver to Docker Requirements Source: https://github.com/apache/superset/blob/master/docs/user_docs_versioned_docs/version-6.1.0/databases/index.mdx To install database drivers in a Docker deployment, add the driver package name to the `requirements-local.txt` file in the `docker` directory. This example shows how to add the PostgreSQL driver. ```bash # Create the requirements file touch ./docker/requirements-local.txt # Add your driver (e.g., for PostgreSQL) echo "psycopg2-binary" >> ./docker/requirements-local.txt ``` -------------------------------- ### Installing Superset 0.25.0 Source: https://github.com/apache/superset/blob/master/UPDATING.md After installing pinned dependencies, install Superset 0.25.0. ```bash pip install superset==0.25.0 ``` -------------------------------- ### Install Python Dependencies Source: https://github.com/apache/superset/blob/master/docs/DOCS_CLAUDE.md Install the Python dependencies for Superset using pip. This command installs the package in editable mode. ```bash pip install -e . ``` -------------------------------- ### Launch Superset - Lightweight Development Instance Source: https://github.com/apache/superset/blob/master/docs/admin_docs/installation/docker-compose.mdx Start a single lightweight Superset instance using a specific compose file. This is suitable for development with fewer resources. ```bash # Single lightweight instance (default port 9001) docker compose -f docker-compose-light.yml up ``` -------------------------------- ### Install Dependencies Source: https://github.com/apache/superset/blob/master/superset-websocket/README.md Installs project dependencies using npm ci. This command ensures that the exact versions of dependencies specified in the package-lock.json are installed. ```bash npm ci ``` -------------------------------- ### Run @superset-ui Package Storybook Source: https://github.com/apache/superset/blob/master/docs/developer_docs/testing/storybook.md Commands to bootstrap and start the Storybook instance for @superset-ui packages. ```bash cd superset-frontend # Install dependencies and bootstrap packages npm ci && npm run bootstrap # Start the @superset-ui Storybook (opens at http://localhost:9001) cd packages/superset-ui-demo npm run storybook ``` -------------------------------- ### Install macOS Development Tools Source: https://github.com/apache/superset/blob/master/docs/admin_docs/installation/pypi.mdx Installs the Xcode command line tools, which are necessary for building and installing Python packages with native extensions on macOS. ```bash xcode-select --install ``` -------------------------------- ### Start Superset WebSocket Server Source: https://github.com/apache/superset/blob/master/superset-websocket/utils/client-ws-app/README.md Navigate to the parent directory and run the development server for Superset's WebSocket functionality. ```bash cd .. npm run dev-server ``` -------------------------------- ### Install Database Driver with pip Source: https://github.com/apache/superset/blob/master/docs/user_docs_versioned_docs/version-6.1.0/databases/index.mdx For non-Docker installations, use pip to install the required database driver package. Replace `` with the actual package name for your database. ```bash pip install ``` -------------------------------- ### Load Example Data and Dashboards Source: https://github.com/apache/superset/blob/master/docs/admin_docs/installation/kubernetes.mdx This configuration snippet enables the loading of example data and dashboards into Superset upon initial deployment. This is useful for exploring Superset's features. ```yaml init: loadExamples: true ``` -------------------------------- ### Conventional Commit Examples Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/submitting-pr.md Examples of complete Conventional Commit messages. ```text feat(sqllab): add query cost estimation fix(dashboard): resolve filter cascading issue docs(api): update REST endpoint documentation refactor(explore): simplify chart controls logic perf(dashboard): optimize chart loading ``` -------------------------------- ### Development Mode Output Example Source: https://github.com/apache/superset/blob/master/docs/developer_docs/extensions/development.md Example output when running the `superset-extensions dev` command, indicating successful asset building, file syncing, and watching for changes. ```bash superset-extensions dev ⚙️ Building frontend assets… ✅ Frontend rebuilt ✅ Backend files synced ✅ Manifest updated 👀 Watching for changes in: /dataset_references/frontend, /dataset_references/backend ``` -------------------------------- ### Install and Use nvm for Node.js Management Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/development-setup.md Install Node Version Manager (nvm) and use it to install and switch to the LTS version of Node.js required for Superset frontend development. ```bash curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.0/install.sh | bash in case it shows '-bash: nvm: command not found' export NVM_DIR="$HOME/.nvm" [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion cd superset-frontend nvm install --lts nvm use --lts ``` -------------------------------- ### Start Superset Development Server Source: https://github.com/apache/superset/blob/master/docs/admin_docs/installation/pypi.mdx Start the Superset development web server, optionally specifying a port, enabling threads, and live reloading. ```bash superset run -p 8088 --with-threads --reload ``` -------------------------------- ### Example Migration Output Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/development-setup.md Illustrates the expected output when running `superset db upgrade` after a migration. ```log INFO [alembic.runtime.migration] Context impl SQLiteImpl. INFO [alembic.runtime.migration] Will assume transactional DDL. INFO [alembic.runtime.migration] Running upgrade 1a1d627ebd8e -> 40a0a483dd12, add_metadata_column_to_annotation_model.py ``` -------------------------------- ### Verify Installation Source: https://github.com/apache/superset/blob/master/superset/mcp_service/PRODUCTION.md Commands to confirm the Superset installation and MCP CLI availability. ```bash superset version superset mcp --help ``` -------------------------------- ### Example Usage of Superset UI Core Utilities Source: https://github.com/apache/superset/blob/master/superset-frontend/packages/superset-ui-core/README.md Demonstrates how to use number formatting, translation, and API calling utilities from the core package. Ensure necessary imports are included. ```javascript import { getNumberFormatter, makeApi } from '@superset-ui/core'; import { t } from '@apache-superset/core/translation'; // Format a number const formatter = getNumberFormatter('.2f'); console.log(formatter(1234.5)); // "1234.50" // Translate a string console.log(t('Hello %s', 'world')); // Call a Superset API endpoint const fetchDashboards = makeApi({ method: 'GET', endpoint: '/api/v1/dashboard', }); ``` -------------------------------- ### Conventional Commit Scope Examples Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/submitting-pr.md Examples of scopes used in Conventional Commits. ```text dashboard: Dashboard functionality sqllab: SQL Lab features explore: Chart explorer chart: Visualization components api: REST API endpoints db: Database connections security: Security features config: Configuration ``` -------------------------------- ### Start Superset with Docker Compose Source: https://github.com/apache/superset/blob/master/docs/docs/quickstart.mdx Navigate to the Superset directory, checkout the latest release tag, and start the Superset services using Docker Compose. Ensure your Docker Compose version is up-to-date. ```bash cd superset # Set the repo to the state associated with the latest official version git checkout tags/6.0.0 # Fire up Superset using Docker Compose docker compose -f docker-compose-image-tag.yml up ``` -------------------------------- ### Configure and Initialize SupersetClient Source: https://github.com/apache/superset/blob/master/superset-frontend/packages/superset-ui-core/src/connection/README.md Configure the SupersetClient with necessary settings and then initialize it. This is typically done once during application setup. ```javascript import { SupersetClient } from `@superset-ui/core`; SupersetClient.configure(...clientConfig); SupersetClient.init(); // CSRF auth, can also chain `.configure().init();` ``` -------------------------------- ### Install Yeoman and generator-superset Source: https://github.com/apache/superset/blob/master/superset-frontend/packages/generator-superset/README.md Global installation of the Yeoman CLI and the Superset generator package. ```bash npm install -g yo npm install -g @superset-ui/generator-superset ``` -------------------------------- ### Install Superset Embedded SDK Source: https://github.com/apache/superset/blob/master/docs/docs/using-superset/embedding.mdx Install the necessary SDK package using npm. ```bash npm install @superset-ui/embedded-sdk ``` -------------------------------- ### Complete Tool Example Source: https://github.com/apache/superset/blob/master/docs/developer_docs/extensions/mcp.md A comprehensive example demonstrating best practices for MCP tool registration, including Pydantic models for request validation and detailed response structures. ```APIDOC ## Complete Example ### Description This example shows best practices for creating an MCP tool, including request validation using Pydantic and a structured response. ### Request Schema ```python from pydantic import BaseModel, Field class RandomNumberRequest(BaseModel): """Request schema for random number generation.""" min_value: int = Field( description="Minimum value (inclusive) for random number generation", ge=-2147483648, le=2147483647 ) max_value: int = Field( description="Maximum value (inclusive) for random number generation", ge=-2147483648, le=2147483647 ) ``` ### Tool Implementation ```python import random from datetime import datetime, timezone from superset_core.mcp.decorators import tool @tool( name="example_extension.random_number", tags=["extension", "utility", "random", "generator"] ) def random_number_generator(request: RandomNumberRequest) -> dict: """ Generate a random integer between specified bounds. This tool validates input ranges and provides detailed error messages for invalid requests. """ # Validate business logic (Pydantic handles type/range validation) if request.min_value > request.max_value: return { "status": "error", "error": f"min_value ({request.min_value}) cannot be greater than max_value ({request.max_value})", "timestamp": datetime.now(timezone.utc).isoformat() } # Generate random number result = random.randint(request.min_value, request.max_value) return { "status": "success", "random_number": result, "min_value": request.min_value, "max_value": request.max_value, "range_size": request.max_value - request.min_value + 1, "timestamp": datetime.now(timezone.utc).isoformat() } ``` ### Tool Name `example_extension.random_number` ### Tool Description Generate a random integer between specified bounds. This tool validates input ranges and provides detailed error messages for invalid requests. ### Tool Tags `extension`, `utility`, `random`, `generator` ### Response Format (Success) ```json { "status": "success", "random_number": 123, "min_value": 1, "max_value": 1000, "range_size": 1000, "timestamp": "2024-01-01T00:00:00Z" } ``` ### Response Format (Error) ```json { "status": "error", "error": "min_value (100) cannot be greater than max_value (5)", "timestamp": "2024-01-01T00:00:00Z" } ``` ``` -------------------------------- ### Run WebSocket Server in Development Source: https://github.com/apache/superset/blob/master/superset-websocket/README.md Command to start the WebSocket server for local development using npm. ```bash npm run dev-server ``` -------------------------------- ### Setup Host Application API Source: https://github.com/apache/superset/blob/master/docs/developer_docs/extensions/architecture.md Map Superset core APIs to `window.superset` during application bootstrap. This ensures extensions can access host APIs when they import from '@apache-superset/core'. ```typescript import * as supersetCore from '@apache-superset/core'; export default function setupExtensionsAPI() { window.superset = { ...supersetCore, }; } ``` -------------------------------- ### Conventional Commit Type Examples Source: https://github.com/apache/superset/blob/master/docs/developer_docs/contributing/submitting-pr.md Examples of commit types used in Conventional Commits. ```text feat: New feature fix: Bug fix docs: Documentation only style: Code style (formatting, semicolons, etc.) refactor: Code refactoring perf: Performance improvement test: Adding tests chore: Maintenance tasks ci: CI/CD changes build: Build system changes revert: Reverting changes ``` -------------------------------- ### Run WebSocket Server in Production Source: https://github.com/apache/superset/blob/master/superset-websocket/README.md Commands to build and start the WebSocket server for production deployment using npm. ```bash npm run build && npm start ``` -------------------------------- ### Scaffold a New Superset Extension Source: https://github.com/apache/superset/blob/master/superset-extensions-cli/README.md Use the 'init' command to create a new extension project. You can provide details interactively or as arguments. ```bash # Scaffold a new extension project (interactive prompts, or pass options directly) superset-extensions init [--publisher ] [--name ] [--display-name ] [--version ] [--license ] [--frontend/--no-frontend] [--backend/--no-backend] ``` -------------------------------- ### Select Component Live Example Source: https://github.com/apache/superset/blob/master/docs/developer_docs/components/ui/select.mdx A basic live example demonstrating the Select component with search functionality. It requires a container with a defined width. ```tsx function Demo() { return (