mirror of
https://github.com/qlik-oss/nebula.js.git
synced 2025-12-19 17:58:43 -05:00
48da7893b83343c46399a77cd62250b79c48928e
nebula.js
Getting started
Prerequisites
- node.js
v8.0.0+ - Qlik Engine
- which comes bundled with one of the following products
- Qlik Sense Desktop
- Qlik Sense Enterprise (coming soon)
- or by running it in a Docker container through either
- Qlik Core
- or the
qlikcore/engineimage
- which comes bundled with one of the following products
Creating a new project
The easiest way to get started is to create a new project using the nebula CLI through npx:
npx @nebula.js/cli create hello-sunshine
or by doing a global install and running the nebula command:
npm install @nebula.js/cli -g
nebula create hello-sunshine
This will create a directory called hello-sunshine with the following content:
hello-sunshine
├─ README.md
├─ package.json
├─ .editorconfig
├─ .eslintrc.json
├─ .gitignore
└─ src
├─ index.js
└─ object-properties.js
The package.json contains a few built-in npm commands:
npm start
Starts a web development server.
The server needs to connect to a running instance of Qlik Engine and by default assumes it's already running on port 9076. If you don't have Qlik Sense desktop installed you can opt-in to start a Docker image of Qlik Engine by accepting the Qlik Core EULA:
ACCEPT_EULA=yes npm start
npm run build
Builds the supernova for production into the dist folder. At this stage you can publish the supernova to npm using the command npm publish.
npm lint
Checks for code syntax issues.
Languages
JavaScript
99.5%
HTML
0.4%