Debug Superset plugins in Superset app

Activate plugins for local development

  1. First, make sure you have run yarn and yarn build in superset-ui or your own plugin repo.

  2. Go to superset-frontend, use npm link to create a symlink of the plugin source code in node_modules:

    cd incubator-superset/superset-frontend
    # npm link ~/path/to/your/plugin
    npm link ../../superset-ui/plugins/plugin-chart-word-cloud
    
  3. Start developing with webpack dev server:

    npm run dev-server
    

    The dev server will automatically build from the source code under path/to/your-plugin/src and watch the changes.

Deactivate plugins

To deactivate a plugin, simply run npm install in incubator-superset/superset-frontend again.