mirror of
https://github.com/apache/superset.git
synced 2024-09-16 10:39:55 -04:00
8dea7f500b
* fix(generator): more cleanup to plugin framework * fix typo and package name * add docs * fix typo * Update superset-frontend/webpack.config.js Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com> * fix generator reference * add steps to tutorial and fix package version * refine docs/readme Co-authored-by: Kamil Gabryjelski <kamil.gabryjelski@gmail.com>
52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one
|
|
or more contributor license agreements. See the NOTICE file
|
|
distributed with this work for additional information
|
|
regarding copyright ownership. The ASF licenses this file
|
|
to you under the Apache License, Version 2.0 (the
|
|
"License"); you may not use this file except in compliance
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations
|
|
under the License.
|
|
-->
|
|
|
|
# generator-superset
|
|
|
|
[](https://www.npmjs.com/package/@superset-ui/generator-superset)
|
|
[](https://david-dm.org/apache-superset/superset-ui?path=packages/generator-superset)
|
|
|
|
> Scaffolder for Superset
|
|
|
|
## Installation
|
|
|
|
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/)).
|
|
|
|
```bash
|
|
npm install -g yo
|
|
npm install -g @superset-ui/generator-superset
|
|
```
|
|
|
|
## Usage
|
|
|
|
Generate a new package or visualization plugin:
|
|
|
|
```bash
|
|
mkdir /tmp/superset-plugin-chart-hello-world
|
|
cd /tmp/superset-plugin-chart-hello-world
|
|
yo @superset-ui/superset
|
|
```
|
|
|
|
## License
|
|
|
|
Apache-2.0
|
|
|
|
[learn more about Yeoman](http://yeoman.io/).
|