pt/superset
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2024-09-19 20:19:37 -04:00
Code Issues Packages Projects Releases Wiki Activity
1d4e5c07ab
superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/superset-ui-plugins
History
dependabot-preview[bot] 1d4e5c07ab build(deps): update @data-ui/event-flow requirement (#129) 
Updates the requirements on [@data-ui/event-flow](https://github.com/williaster/data-ui) to permit the latest version.
- [Release notes](https://github.com/williaster/data-ui/releases)
- [Changelog](https://github.com/williaster/data-ui/blob/master/CHANGELOG.md)
- [Commits](https://github.com/williaster/data-ui/compare/v0.0.78...v0.0.79)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-11-26 11:45:38 +08:00
..
.github chore: create issue_label_bot.yaml (#62) 2021-11-26 11:45:28 +08:00
packages build(deps): update @data-ui/event-flow requirement (#129) 2021-11-26 11:45:38 +08:00
.gitignore Enable TypeScript live update in Storybook (#5) 2021-11-26 11:45:22 +08:00
.npmrc initial commit 2021-11-26 11:45:09 +08:00
.travis.yml test: enable test in ci (#83) 2021-11-26 11:45:31 +08:00
buildAssets.js make build work for country map 2021-11-26 11:45:14 +08:00
CHANGELOG.md docs: update changelog 2021-11-26 11:45:38 +08:00
commitlint.config.js build: use shared commit config (#35) 2021-11-26 11:45:26 +08:00
lerna.json v0.10.32 2021-11-26 11:45:38 +08:00
LICENSE initial commit 2021-11-26 11:45:09 +08:00
package.json build(deps-dev): update fast-glob requirement from ^2.2.6 to ^3.0.1 (#128) 2021-11-26 11:45:38 +08:00
README.md docs: add storybook local run instructions (#123) 2021-11-26 11:45:38 +08:00

README.md

@superset-ui/plugins 🔌💡

Codecov branch Build Status David Netlify Status

@superset-ui/legacy-* packages are extracted from the classic Apache Superset and converted into plugins. These packages are extracted with minimal changes (almost as-is). They also depend on legacy API (viz.py) to function.

@superset-ui/plugin-* packages are newer and has higher quality in general.

We are not accepting pull requests for new community-contributed plugins to be merged into this repository at the moment. We will keep it lean for now to improve the standard and reduce operational load on maintenance. Bug fixes are welcome.

In the future, we plan to have a template for new repository or generator for everybody to setup a single plugin repository easily on his/her own. This way anybody can create and publish a Superset plugin.

Demo (Storybook)

Most recent release: https://apache-superset.github.io/superset-ui-plugins/

Current master: https://superset-ui-plugins.netlify.com

Packages

Package Version Note
@superset-ui/plugin-chart-word-cloud Version
@superset-ui/preset-chart-xy Version experimental
Package Version
@superset-ui/legacy-preset-chart-big-number Version
@superset-ui/legacy-preset-chart-nvd3 Version
@superset-ui/legacy-plugin-chart-calendar Version
@superset-ui/legacy-plugin-chart-chord Version
@superset-ui/legacy-plugin-chart-country-map Version
@superset-ui/legacy-plugin-chart-event-flow Version
@superset-ui/legacy-plugin-chart-force-directed Version
@superset-ui/legacy-plugin-chart-heatmap Version
@superset-ui/legacy-plugin-chart-histogram Version
@superset-ui/legacy-plugin-chart-horizon Version
@superset-ui/legacy-plugin-chart-iframe Version
@superset-ui/legacy-plugin-chart-markup Version
@superset-ui/legacy-plugin-chart-map-box Version
@superset-ui/legacy-plugin-chart-paired-t-test Version
@superset-ui/legacy-plugin-chart-parallel-coordinates Version
@superset-ui/legacy-plugin-chart-partition Version
@superset-ui/legacy-plugin-chart-pivot-table Version
@superset-ui/legacy-plugin-chart-rose Version
@superset-ui/legacy-plugin-chart-sankey Version
@superset-ui/legacy-plugin-chart-sankey-loop Version
@superset-ui/legacy-plugin-chart-sunburst Version
@superset-ui/legacy-plugin-chart-table Version
@superset-ui/legacy-plugin-chart-treemap Version
@superset-ui/legacy-plugin-chart-word-cloud Version
@superset-ui/legacy-plugin-chart-world-map Version

Development

lerna and yarn are used to manage versions and dependencies between packages in this monorepo.

superset-ui/
  lerna.json
  package.json
  ...
  packages/
    package1/
      package.json
      ...
      src/
      test/
      ...
      lib/
      esm/
      ...
    ...

Installation

  1. clone this repo
  2. have yarn install package dependencies and manage the symlinking between packages for you
git clone ...superset-ui-plugins && cd superset-ui-plugins
yarn install
yarn build

Builds, linting, and testing

Each package defines its own build config, linting, and testing. You can have lerna run commands across all packages using the syntax yarn run test (or yarn run test:watch for watch mode) from the root @superset-ui directory.

Storybook

You can demo your changes by running the storybook demo locally with the following commands:

yarn install
yarn build
cd packages/superset-ui-plugins-demo
yarn storybook

Committing

This repository follows conventional commits guideline for commit messages and has a commitlint hook which will require you to have the valid commit message before committing. You can use npm run commit to help you create a commit message.

Publishing

Prerequisite: You'll need an npmjs.com account that is part of the @superset-ui organization.

  1. Make sure you're logged in to NPM from your shell. Run npm login if necessary.
  2. To make the release, run yarn run release and follow the prompts.

License

Apache-2.0