2018-11-07 19:03:20 -05:00
|
|
|
# generator-superset
|
|
|
|
|
|
|
|
[![Version](https://img.shields.io/npm/v/@superset-ui/generator-superset.svg?style=flat)](https://img.shields.io/npm/v/@superset-ui/generator-superset.svg?style=flat-square)
|
|
|
|
[![David (path)](https://img.shields.io/david/apache-superset/superset-ui.svg?path=packages%2Fgenerator-superset&style=flat-square)](https://david-dm.org/apache-superset/superset-ui?path=packages/generator-superset)
|
|
|
|
|
|
|
|
> Scaffolder for Superset
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
2020-07-02 11:52:24 -04:00
|
|
|
First, install [Yeoman](http://yeoman.io) and `generator-superset` using
|
|
|
|
[npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
|
2018-11-07 19:03:20 -05:00
|
|
|
|
|
|
|
```bash
|
|
|
|
npm install -g yo
|
|
|
|
npm install -g @superset-ui/generator-superset
|
|
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2020-07-02 11:52:24 -04:00
|
|
|
Generate a new package or visualization plugin in `@superset-ui`
|
2018-11-07 19:03:20 -05:00
|
|
|
|
|
|
|
```bash
|
|
|
|
cd superset-ui/packages
|
|
|
|
mkdir superset-ui-new-package
|
|
|
|
cd superset-ui-new-package
|
|
|
|
yo @superset-ui/superset
|
|
|
|
```
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
Apache-2.0
|
|
|
|
|
|
|
|
[learn more about Yeoman](http://yeoman.io/).
|