@nebula.js/cli-serve 3.1.1 → 3.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -26
- package/dist/eHub.js +3 -3
- package/dist/eRender.html +1 -0
- package/dist/eRender.js +9 -9
- package/lib/init-config.js +9 -2
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -18,28 +18,35 @@ nebula serve -h
|
|
|
18
18
|
Start a development server
|
|
19
19
|
|
|
20
20
|
Options:
|
|
21
|
-
|
|
22
|
-
--config
|
|
21
|
+
--version Show version number [boolean]
|
|
22
|
+
-c, --config Path to JSON config file
|
|
23
23
|
[string] [default: "nebula.config.js"]
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
24
|
+
--entry File entrypoint [string]
|
|
25
|
+
--type Generic object type [string]
|
|
26
|
+
--build Build the nebula visualization into /dist dictionary
|
|
27
|
+
[boolean] [default: true]
|
|
28
|
+
--host Specify a host to use[string] [default: "localhost"]
|
|
29
|
+
--port Specify a port number to listen for requests on
|
|
30
|
+
[number]
|
|
31
|
+
--disableHostCheck Bypasses host checking [boolean] [default: false]
|
|
32
|
+
--keyboardNavigation Whether or not Nebula handles keyboard navigation
|
|
33
|
+
[boolean] [default: false]
|
|
34
|
+
--resources Path to a folder that will be served as static files
|
|
35
|
+
under /resources [string]
|
|
36
|
+
--scripts Array of scripts to inject [array]
|
|
37
|
+
--stylesheets Array of stylesheets to inject [array]
|
|
38
|
+
--enigma.host Set host to communicate with Qlik Associative Engine
|
|
39
|
+
[string] [default: "localhost"]
|
|
40
|
+
--enigma.port Set port to communicate with Qlik Associative Engine
|
|
41
|
+
[number] [default: 9076]
|
|
42
|
+
--clientId Tenant's clientId for OAuth connection [string]
|
|
43
|
+
--webIntegrationId Tenant's webIntegrationId for connection [string]
|
|
44
|
+
--fixturePath Path to a folder that will be used as basis when
|
|
45
|
+
locating fixtures
|
|
46
|
+
[string] [default: "test/component"]
|
|
47
|
+
--mfe Serves bundle to use in micro frontend
|
|
48
|
+
[boolean] [default: false]
|
|
49
|
+
-h, --help Show help [boolean]
|
|
43
50
|
```
|
|
44
51
|
|
|
45
52
|
#### Example
|
|
@@ -93,14 +100,14 @@ serve({
|
|
|
93
100
|
|
|
94
101
|
### Micro Frontend (MFE) Mode
|
|
95
102
|
|
|
96
|
-
The MFE mode
|
|
97
|
-
used in a micro frontend
|
|
103
|
+
The MFE mode activated with the `--mfe` option, builds a visualisation which is
|
|
104
|
+
used in a micro frontend environment. The visualisation is served at:
|
|
98
105
|
|
|
99
106
|
```
|
|
100
107
|
https://<host>:<port>/pkg/<module name>
|
|
101
108
|
```
|
|
102
109
|
|
|
103
|
-
The module name is by default the name in `package.json` but may be
|
|
110
|
+
The module name is by default the name in `package.json` but may be overridden using the
|
|
104
111
|
`--type` option.
|
|
105
112
|
|
|
106
113
|
The MFE mode runs in HTTPS which requires certificates to be installed in the
|
|
@@ -110,7 +117,7 @@ The regular dev environment in nebula serve is disabled when running in this mod
|
|
|
110
117
|
|
|
111
118
|
#### How to install trusted certificates locally
|
|
112
119
|
|
|
113
|
-
There are a few ways to install
|
|
120
|
+
There are a few ways to install locally trusted certificates on your machine, The important
|
|
114
121
|
end result is that there are two files `~/.certs/cert.pem` (the certificate) and
|
|
115
122
|
`~/.certs/key.pem` (the public key). Read about how certificates work
|
|
116
123
|
[here](http://www.steves-internet-guide.com/ssl-certificates-explained/). If you already
|
|
@@ -124,7 +131,7 @@ Install mkcert - [documentation](https://github.com/FiloSottile/mkcert)
|
|
|
124
131
|
brew install mkcert
|
|
125
132
|
```
|
|
126
133
|
|
|
127
|
-
Make sure the active directory is user folder and run the following:
|
|
134
|
+
Make sure the active directory is the user folder and run the following:
|
|
128
135
|
|
|
129
136
|
```sh
|
|
130
137
|
$ mkdir ~/.certs
|
|
@@ -136,3 +143,7 @@ $ mkcert -key-file ~/.certs/key.pem -cert-file ~/.certs/cert.pem localhost 127.0
|
|
|
136
143
|
```
|
|
137
144
|
|
|
138
145
|
Verify that two new files have appeared in the certs/ - folder
|
|
146
|
+
|
|
147
|
+
### More info
|
|
148
|
+
|
|
149
|
+
webpack and webpack-dev-server are used behind the web development server for nebula.js visualizations. You can find more info from [webpack configuration](https://webpack.js.org/configuration/) and [webpack-dev-server configuration](https://webpack.js.org/configuration/dev-server/#devserverport).
|