[streampipes] 03/03: docs: [apache/streampipes#771] add README for ui

[ze...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes.git

commit b1691b7949a6214dffc69fb9dfdb985f82870408
Author: Samuel Abt <gi...@samuelabt.de>
AuthorDate: Tue Dec 20 23:14:13 2022 +0100

    docs: [apache/streampipes#771] add README for ui
---
 ui/README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/ui/README.md b/ui/README.md
new file mode 100644
index 000000000..72e8d47c8
--- /dev/null
+++ b/ui/README.md
@@ -0,0 +1,38 @@
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to You under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~    http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~
+  -->
+
+# Streampipes UI
+
+## Development
+
+Please make sure you have a recent version of [node](https://nodejs.org/en/) and npm (bundled with node) installed.
+
+To build the ui, perform the following steps:
+
+```
+    npm install
+    # for NPM > v7, run npm install --legacy-peer-deps
+    npm run build
+```
+
+### Formatting and Linting
+
+Running `npm install` will cause a pre-commit hook to be created.
+This hook ensures that if you want to commit changes to this repository, these changes are compliant with our [formatting](https://prettier.io/) and [linting](https://eslint.org/) rules.
+
+If you see errors there, you can try to run `npm run format:fix` and `npm run lint:fix` to fix these issues automatically. Otherwise you have to run `npm run format` and `npm run lint` to get additional information about the problems.