You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/02/20 14:59:42 UTC
[streampipes] 01/01: chore(docs): add information on how to develop the UI locally
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch chore/ui-add-dev-info
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit c68ca715517bad495f0a9a831086543bf6ff9cb8
Author: bossenti <bo...@posteo.de>
AuthorDate: Mon Feb 20 15:59:29 2023 +0100
chore(docs): add information on how to develop the UI locally
---
ui/README.md | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/ui/README.md b/ui/README.md
index 812ce3eee..91c19f6eb 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.