mirror of
https://github.com/apache/superset.git
synced 2024-09-19 12:09:42 -04:00
8dea7f500b
* fix(generator): more cleanup to plugin framework * fix typo and package name * add docs * fix typo * Update superset-frontend/webpack.config.js Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com> * fix generator reference * add steps to tutorial and fix package version * refine docs/readme Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com> |
||
---|---|---|
.. | ||
src | ||
test | ||
types | ||
babel.config.erb | ||
gitignore.erb | ||
jest.config.erb | ||
package.erb | ||
README.erb | ||
tsconfig.json |
# <%= packageName %> This is the <%= description %> Superset Chart Plugin. ### Usage To build the plugin, run the following commands: ``` npm i --force npm run build ``` Alternatively, to run the plugin in development mode (=rebuilding whenever changes are made), start the dev server with the following command: ``` npm run dev ``` To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `<%= packageName %>` plugin and `superset` repos are in the same root directory) and run ``` npm i -S ../../<%= packageName %> ``` After this edit the `superset-frontend/src/visualizations/presets/MainPreset.js` and make the following changes: ```js import { <%= packageLabel %> } from '<%= packageName %>'; ``` to import the plugin and later add the following to the array that's passed to the `plugins` property: ```js new <%= packageLabel %>().configure({ key: '<%= packageName %>' }), ``` After that the plugin should show up when you run Superset, e.g. the development server: ``` npm run dev-server ```