mirror of
https://github.com/qlik-oss/nebula.js.git
synced 2026-05-25 01:00:13 -04:00
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
<p align="center">
|
|
<img width="500" src="./docs/assets/logos/nebula.png" alt="nebula.js logo" />
|
|
</p>
|
|
<p align="center">A new star on the rise</p>
|
|
|
|
NebulaJS is a collection of JavaScript libraries, charts and CLIs that helps developers build and integrate visualizations on top of Qlik's Associative Engine. The collection is organized under the `@nebula.js` npm scope.
|
|
|
|
The primary package is `@nebula.js/stardust` which contains APIs for integrating existing visualizations into mashups, as well as APIs for building custom visualizations.
|
|
|
|
## Documentation
|
|
|
|
You can find the documentation on [Qlik's developer portal](https://qlik.dev/libraries-and-tools/nebulajs).
|
|
|
|
To quickly get started, check out the tutorial on how to [embed visualization into your own web app](https://qlik.dev/tutorials/build-a-simple-mashup-using-nebulajs).
|
|
|
|
You can also walk through the tutorial on how to [build your own extension](https://qlik.dev/tutorials/build-a-helloworld-extension-using-nebulajs).
|
|
|
|
Explore the full [stardust API reference](https://qlik.dev/apis/javascript/nebulajs-stardust).
|
|
|
|
## Contributing
|
|
|
|
Follow the instructions in our [contributing guide](./.github/CONTRIBUTING.md).
|
|
|
|
## Core modules
|
|
|
|
| name | status | description |
|
|
| ---------- | ---------------------------------- | --------------------- |
|
|
| [stardust] | [![stardust-status]][stardust-npm] | Core nebula.js module |
|
|
|
|
## License
|
|
|
|
`nebula.js/stardust` is [MIT licensed](./LICENSE).
|
|
|
|
[stardust]: https://github.com/qlik-oss/apis/stardust
|
|
[stardust-status]: https://img.shields.io/npm/v/@nebula.js/stardust.svg
|
|
[stardust-npm]: https://www.npmjs.com/package/@nebula.js/stardust
|