Skip to content

Commit

Permalink
docs(nebula-create): add example docs for nebula create (#662)
Browse files Browse the repository at this point in the history
* docs(nebula-create): add example docs for nebula create

* docs(nebula-create): fix typo

Co-authored-by: Tobias Åström <tsm@qlik.com>

Co-authored-by: Tobias Åström <tsm@qlik.com>
  • Loading branch information
LiKang6688 and Caele committed Sep 8, 2021
1 parent f0678d2 commit 5afb092
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions commands/create/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,48 @@ Options:
nebula create hello-sunshine
```

Running nebula create without --picasso prompts a selection of the available
options.

- none: without the picasso.js template
- minimal: a basic setup of picasso.js is ready
- barchart: a bar chart component created by picasso.js is ready

You can find the [tutorial](https://qlik.dev/tutorials/build-a-helloworld-extension-using-nebulajs) to build a basic nebula visualization using nebula.js.

#### Create a mashup

```sh
nebula create mashup hello-mashie
```

You can find the [tutorial](https://qlik.dev/tutorials/build-a-simple-mashup-using-nebulajs) to build a basic mashup using nebula.js.

#### Package manager

Create a nebula visualization project called `sn-table` with the npm package manager
instead of yarn

```sh
nebula create sn-table --pkgm npm
```

Create a mashup called `table-mashup` with the npm package manager instead of yarn

```sh
nebula create mashup table-mashup --pkgm npm
```

#### Package installation step

Create a nebula visualization project and do not install any dependencies yet

```sh
nebula create sn-table --install false
```

Create a mashup and do not install any dependencies yet

```sh
nebula create mashup table-mashup --install false
```

0 comments on commit 5afb092

Please sign in to comment.