You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by ja...@apache.org on 2024/02/22 07:32:47 UTC
(pinot) branch master updated: Readme - How to setup Pinot UI for development (#12408)
This is an automated email from the ASF dual-hosted git repository.
jackie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pinot.git
The following commit(s) were added to refs/heads/master by this push:
new b7893bd0aa Readme - How to setup Pinot UI for development (#12408)
b7893bd0aa is described below
commit b7893bd0aa499b7602d5017479435f0918df8c37
Author: Jayesh Choudhary <ja...@gmail.com>
AuthorDate: Thu Feb 22 13:02:40 2024 +0530
Readme - How to setup Pinot UI for development (#12408)
---
CONTRIBUTING.md | 2 ++
pinot-controller/src/main/resources/Readme.md | 20 ++++++++++++++++++++
2 files changed, 22 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e1c92e5d57..d87c29fceb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -22,6 +22,8 @@
Before you begin to contribute, make sure you have reviewed [Dev Environment Setup](https://docs.pinot.apache.org/developers/developers-and-contributors/code-setup) and [Code Modules and Organization](https://docs.pinot.apache.org/developers/developers-and-contributors/code-modules-and-organization) sections and that you have created your own fork of the pinot source code.
+> If you wish to contribute to the UI codebase, follow [this guide](/pinot-controller/src/main/resources/Readme.md) to setup UI locally for development.
+
### Create a design document
If your change is relatively minor, you can skip this step. If you are adding new major feature, we suggest that you add a design document and solicit comments from the community before submitting any code.
diff --git a/pinot-controller/src/main/resources/Readme.md b/pinot-controller/src/main/resources/Readme.md
new file mode 100644
index 0000000000..9a5891069a
--- /dev/null
+++ b/pinot-controller/src/main/resources/Readme.md
@@ -0,0 +1,20 @@
+# Pinot Controller UI
+This package contains code for Pinot Controller UI.
+
+## How to setup Pinot UI for development
+
+1. Make sure pinot backend is running on port 9000. Follow [this guide](https://github.com/apache/pinot?tab=readme-ov-file#building-pinot) for the same.
+2. Navigate to ui source code folder
+```shell
+cd pinot-controller/src/main/resources
+```
+3. Install Required Packages. Make sure you are using node v14 or more specifially v14.18.1
+```shell
+npm install
+```
+4. Start the Development Server
+```shell
+npm run dev
+```
+
+5. App should be running on [http://localhost:8080](http://localhost:8080)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org