@nebula.js/cli-serve

Basic web development server for nebula.js visualizations.

Install

``sh
npm install @nebula.js/cli @nebula.js/cli-serve -g
`

Usage

$3

`sh
nebula serve -h

Start a development server

Options:
--version Show version number [boolean]
-c, --config Path to JSON config file
[string] [default: "nebula.config.js"]
--entry File entrypoint [string]
--type Generic object type [string]
--build Build the nebula visualization into /dist dictionary
[boolean] [default: true]
--host Specify a host to use[string] [default: "localhost"]
--port Specify a port number to listen for requests on
[number]
--disableHostCheck Bypasses host checking [boolean] [default: false]
--keyboardNavigation Whether or not Nebula handles keyboard navigation
[boolean] [default: false]
--resources Path to a folder that will be served as static files
under /resources [string]
--scripts Array of scripts to inject [array]
--stylesheets Array of stylesheets to inject [array]
--enigma.host Set host to communicate with Qlik Associative Engine
[string] [default: "localhost"]
--enigma.port Set port to communicate with Qlik Associative Engine
[number] [default: 9076]
--clientId Tenant's clientId for OAuth connection [string]
--webIntegrationId Tenant's webIntegrationId for connection [string]
--fixturePath Path to a folder that will be used as basis when
locating fixtures
[string] [default: "test/component"]
--mfe Serves bundle to use in micro frontend
[boolean] [default: false]
-h, --help Show help [boolean]
--open Open up in browser [boolean] [default: true]
`

#### Example

Start the server and connect to enigma on port 9077

`sh
nebula serve --enigma.port 9077
`

$3

nebula.config.js

`js
module.exports = {
serve: {
...,
},
};
`

Serve properties:

- types: Additional types to load into the serve instance. Useful in conjunction with useEmbed.
- ex: types: [{ name: 'barchart', url: "https://unpkg.com/@nebula.js/sn-bar-chart"}],
- themes: Theme files to load
- ex: themes: [{ id: 'sense', theme: { / valid sense json theme / } }],
- renderConfigs: configuration for the test renderer
- flags: Additional flag settings for feature toggling
- flags: { SOME_FEATURE: true }
- resources: Adds path to /resources
- snapshots: Snapshots property structure, generally used for automated tests.

$3

`js
const serve = require('@nebula.js/cli-serve');

serve({
port: 3000,
entry: path.resolve(__dirname, 'sn.js') // custom entrypoint
enigma: {
port: 9077
}
}).then(s => {
s.url; // serve url
s.close(); // close the server
});
`

$3

The MFE mode activated with the --mfe option, builds a visualisation which is
used in a micro frontend environment. The visualisation is served at:

`
https://:/pkg/
`

The module name is by default the name in package.json but may be overridden using the
--type option.

The MFE mode runs in HTTPS which requires certificates to be installed in the
environment running nebula serve.

The regular dev environment in nebula serve is disabled when running in this mode.

#### How to install trusted certificates locally

There are a few ways to install locally trusted certificates on your machine, The important
end result is that there are two files ~/.certs/cert.pem (the certificate) and
~/.certs/key.pem (the public key). Read about how certificates work
here. If you already
have a self-signed and trusted certificate in this location, then skip this guide.

##### Easy step-by-step guide to install and generate certificates locally

Install mkcert - documentation

`sh
brew install mkcert
`

Make sure the active directory is the user folder and run the following:

`sh
$ mkdir ~/.certs

$ mkcert -install

$ mkcert -key-file ~/.certs/key.pem -cert-file ~/.certs/cert.pem localhost 127.0.0.1 ::1

``

Verify that two new files have appeared in the certs/ - folder

$3

webpack and webpack-dev-server are used behind the web development server for nebula.js visualizations. You can find more info from webpack configuration and webpack-dev-server configuration.