@nebula.js/cli-serve 3.0.0-rc.1 → 3.0.0-rc.3

package/README.md

@@ -37,6 +37,7 @@ Options:
   --webIntegrationId                                                    [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]
   -h, --help          Show help                                        [boolean]
 ```
 
@@ -88,3 +89,49 @@ serve({
   s.close(); // close the server
 });
 ```
+
+### Micro Frontend (MFE) Mode
+
+The MFE mode, activated with the `--mfe` option, builds a visualisation which is
+used in a micro frontend environemnt. The visualisation is served at:
+
+```
+https://<host>:<port>/pkg/<module name>
+```
+
+The module name is by default the name in `package.json` but may be overriden 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 local 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](http://www.steves-internet-guide.com/ssl-certificates-explained/). 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](https://github.com/FiloSottile/mkcert)
+
+```sh
+brew install mkcert
+```
+
+Make sure the active directory is 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