messages in log files. There are several more options to chose from. You can
get a list using the ``--help`` argument.
-At the end of the output of vstart, there should be information about the
+At the end of the output of vstart, there should be information about the
dashboard and its URLs::
vstart cluster complete. Use stop.sh to stop. See out/* (e.g. 'tail -f out/????') for debug output.
Prerequisites
~~~~~~~~~~~~~
- * Node 8.9.0 or higher
+ * Node 10.0.0 or higher
* NPM 5.7.0 or higher
nodeenv:
Package installation
~~~~~~~~~~~~~~~~~~~~
-Run ``npm install`` in directory ``src/pybind/mgr/dashboard/frontend`` to
+Run ``npm ci`` in directory ``src/pybind/mgr/dashboard/frontend`` to
install the required packages locally.
+Adding or updating packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run the following commands to add/update a package::
+
+ npm install <PACKAGE_NAME>
+ npm run fix:audit
+ npm ci
+
+``fix:audit`` is required because we have some packages that need to be fixed
+to a specific version and npm install tends to overwrite this.
+
Setting up a Development Server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `codelyzer <http://codelyzer.com/>`_
- `html-linter <https://github.com/chinchiheather/html-linter>`_
+- `htmllint-cli <https://github.com/htmllint/htmllint-cli>`_
- `Prettier <https://prettier.io/>`_
- `TSLint <https://palantir.github.io/tslint/>`_
Differences between Frontend Unit Tests and End-to-End (E2E) Tests / FAQ
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-General introduction about testing and E2E/unit tests
+General introduction about testing and E2E/unit tests
What are E2E/unit tests designed for?