facb0aa4b3
* docs: [demo] add custom webpack config to resolve TS files * docs: [demo] add @babel/polyfill * docs: [demo][connection] add ConfigureCORS story for testing CORS * docs: [demo][ConfigureCORS] better instructions * fix: [demo] install an existing version of @superset-ui/connection * docs: better CORS story, update webpack for @babel/polyfill |
||
---|---|---|
.. | ||
.github | ||
packages | ||
scripts | ||
.gitignore | ||
.npmrc | ||
.travis.yml | ||
CHANGELOG.md | ||
commitlint.config.js | ||
lerna.json | ||
LICENSE | ||
package.json | ||
README.md |
@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
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
- clone this repo
- 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.
- Make sure you're logged in to NPM from your shell. Run
npm login
if necessary. - To make the release, run
yarn run release
and follow the prompts.
License
Apache-2.0