forciwc / superset-ui

Apache Superset UI packages

@superset-ui

Collection of packages that power the Apache Superset UI, and can be used to craft custom data applications that leverage a Superset backend 📈

Packages

Package	Version
@superset-ui/chart
@superset-ui/color
@superset-ui/connection
@superset-ui/core
@superset-ui/dimension
@superset-ui/generator-superset
@superset-ui/number-format
@superset-ui/time-format
@superset-ui/translation

Coming 🔜

• Data providers
• Chart plugins

Development

lerna is 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 && cd superset-ui
yarn install

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.

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