diff --git a/ui/README.md b/ui/README.md index 812ce3eee2..91c19f6eb6 100644 --- a/ui/README.md +++ b/ui/README.md @@ -24,11 +24,20 @@ Please make sure you have a recent version of [node](https://nodejs.org/en/) and To build the ui, perform the following steps: -``` +```bash npm install npm run build ``` +To test your local version of the UI execute the following commands: + +```bash + npm install + npm start +``` + +(be aware that this requires a StreamPipes instance that runs without the UI, read more [here](https://cwiki.apache.org/confluence/display/STREAMPIPES/UI)) + ### Formatting and Linting Running `npm install` will cause a pre-commit hook to be created.