2018-10-31 01:22:48 -04:00
# @superset-ui
2018-10-30 03:38:02 -04:00
2019-04-09 20:18:00 -04:00
[![Codecov branch ](https://img.shields.io/codecov/c/github/apache-superset/superset-ui/master.svg?style=flat-square )](https://codecov.io/gh/apache-superset/superset-ui/branch/master)
2018-11-02 13:17:37 -04:00
[![Build Status](https://img.shields.io/travis/com/apache-superset/superset-ui/master.svg?style=flat-square
2018-10-30 03:38:02 -04:00
)](https://travis-ci.com/apache-superset/superset-ui)
[![David ](https://img.shields.io/david/dev/apache-superset/superset-ui.svg?style=flat-square )](https://david-dm.org/apache-superset/superset-ui?type=dev)
2019-04-09 20:18:00 -04:00
[![Netlify Status ](https://api.netlify.com/api/v1/badges/fcbfa1cb-ae3e-48a4-b86a-e803c8e6c79c/deploy-status )](https://app.netlify.com/sites/superset-ui/deploys)
2018-09-07 21:36:47 -04:00
2018-11-29 17:18:04 -05:00
Collection of packages that power the [Apache Superset ](https://github.com/apache/incubator-superset ) UI, and can be used to craft custom data
2018-09-07 21:36:47 -04:00
applications that leverage a Superset backend :chart_with_upwards_trend:
2019-04-09 20:18:00 -04:00
## Demo
Most recent release: https://apache-superset.github.io/superset-ui/
Current master: https://superset-ui.netlify.com
2018-09-07 21:36:47 -04:00
## Packages
2018-10-30 03:10:40 -04:00
| Package | Version |
|--|--|
2018-11-06 17:45:50 -05:00
| [@superset-ui/chart ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-chart ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/chart.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/chart.svg?style=flat-square) |
2018-11-03 05:02:41 -04:00
| [@superset-ui/color ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-color ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/color.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/color.svg?style=flat-square) |
2018-11-01 18:12:40 -04:00
| [@superset-ui/connection ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-connection ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/connection.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/connection.svg?style=flat-square) |
| [@superset-ui/core ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-core ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/core.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/core.svg?style=flat-square) |
2019-02-05 13:51:27 -05:00
| [@superset-ui/dimension ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-dimension ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/dimension.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/dimension.svg?style=flat-square) |
2018-11-17 00:55:46 -05:00
| [@superset-ui/generator-superset ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-generator-superset ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/generator-superset.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/generator-superset.svg?style=flat-square) |
| [@superset-ui/number-format ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-number-format ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/number-format.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/number-format.svg?style=flat-square) |
2018-11-29 16:01:57 -05:00
| [@superset-ui/time-format ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-time-format ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/time-format.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/time-format.svg?style=flat-square) |
2018-11-01 18:12:40 -04:00
| [@superset-ui/translation ](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-translation ) | [![Version ](https://img.shields.io/npm/v/@superset-ui/translation.svg?style=flat-square )](https://img.shields.io/npm/v/@superset-ui/translation.svg?style=flat-square) |
2018-09-07 21:36:47 -04:00
### Development
[lerna ](https://github.com/lerna/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/
...
...
```
2018-10-31 01:22:48 -04:00
### Installation
2018-09-07 21:36:47 -04:00
1. clone this repo
2019-04-09 20:18:00 -04:00
2. have `yarn` install package dependencies and manage the symlinking between packages for you
2018-09-07 21:36:47 -04:00
```sh
git clone ...superset-ui & & cd superset-ui
2018-11-07 03:13:22 -05:00
yarn install
2018-09-07 21:36:47 -04:00
```
### Builds, linting, and testing
Each package defines its own build config, linting, and testing. You can have lerna run commands
2018-11-07 03:13:22 -05:00
across all packages using the syntax `yarn run test` (or `yarn run test:watch` for watch mode) from the root `@superset-ui` directory.
2018-09-07 21:36:47 -04:00
2019-02-25 17:00:14 -05:00
### Committing
This repository follows [conventional commits ](https://www.conventionalcommits.org/en/v1.0.0-beta.3/ ) 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.
2018-10-30 03:10:40 -04:00
### Publishing
2019-01-14 14:25:35 -05:00
**Prerequisite:** You'll need an [npmjs.com ](https://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.
2018-10-30 03:10:40 -04:00
2018-09-07 21:36:47 -04:00
### License
Apache-2.0