mirror of
https://github.com/apache/superset.git
synced 2024-09-19 12:09:42 -04:00
66 lines
1.8 KiB
Plaintext
66 lines
1.8 KiB
Plaintext
# <%= packageName %>
|
|
|
|
This is the <%= description %> Superset Chart Plugin.
|
|
|
|
### Usage
|
|
|
|
To build the plugin, run the following commands:
|
|
|
|
```
|
|
npm ci
|
|
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 %>
|
|
```
|
|
|
|
If your Superset plugin exists in the `superset-frontend` directory and you wish to resolve TypeScript errors about `@superset-ui/core` not being resolved correctly, add the following to your `tsconfig.json` file:
|
|
|
|
```
|
|
"references": [
|
|
{
|
|
"path": "../../packages/superset-ui-chart-controls"
|
|
},
|
|
{
|
|
"path": "../../packages/superset-ui-core"
|
|
}
|
|
]
|
|
```
|
|
|
|
You may also wish to add the following to the `include` array in `tsconfig.json` to make Superset types available to your plugin:
|
|
|
|
```
|
|
"../../types/**/*"
|
|
```
|
|
|
|
Finally, if you wish to ensure your plugin `tsconfig.json` is aligned with the root Superset project, you may add the following to your `tsconfig.json` file:
|
|
|
|
```
|
|
"extends": "../../tsconfig.json",
|
|
```
|
|
|
|
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
|
|
```
|