2018-10-31 01:22:48 -04:00
|
|
|
# @superset-ui
|
2018-10-30 03:38:02 -04:00
|
|
|
|
|
|
|
|
[](https://travis-ci.com/apache-superset/superset-ui)
|
|
|
|
|
[](https://david-dm.org/apache-superset/superset-ui?type=dev)
|
2018-09-07 21:36:47 -04:00
|
|
|
|
|
|
|
|
Collection of packages that power the Apache Superset UI, and can be used to craft custom data
|
|
|
|
|
applications that leverage a Superset backend :chart_with_upwards_trend:
|
|
|
|
|
|
|
|
|
|
## Packages
|
|
|
|
|
|
2018-10-30 03:10:40 -04:00
|
|
|
| Package | Version |
|
|
|
|
|
|--|--|
|
2018-10-31 13:14:59 -04:00
|
|
|
| [@superset-ui/connection](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-connection) | [](https://img.shields.io/npm/v/@superset-ui/connection.svg?style=flat) |
|
2018-10-30 03:38:02 -04:00
|
|
|
| [@superset-ui/translation](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-translation) | [](https://img.shields.io/npm/v/@superset-ui/translation.svg?style=flat) |
|
2018-09-07 21:36:47 -04:00
|
|
|
|
|
|
|
|
#### Coming :soon:
|
|
|
|
|
|
|
|
|
|
- Data providers
|
|
|
|
|
- Embeddable charts
|
|
|
|
|
- Chart collections
|
|
|
|
|
- Demo storybook package
|
|
|
|
|
|
|
|
|
|
### 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
|
2018-10-31 01:22:48 -04:00
|
|
|
2. have lerna 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
|
|
|
|
|
npm install
|
2018-10-31 01:22:48 -04:00
|
|
|
npm run bootstrap
|
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-10-31 01:22:48 -04:00
|
|
|
across all packages using the syntax `npm run test` (or `npm run test:watch` for watch mode) from the root `@superset/monorepo` root
|
2018-09-07 21:36:47 -04:00
|
|
|
directory.
|
|
|
|
|
|
2018-10-30 03:10:40 -04:00
|
|
|
### Publishing
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
npm run release
|
|
|
|
|
```
|
|
|
|
|
|
2018-09-07 21:36:47 -04:00
|
|
|
### License
|
|
|
|
|
|
|
|
|
|
Apache-2.0
|
