This is an automated email from the ASF dual-hosted git repository.
benjobs pushed a commit to branch dev
in repository
https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 88aeda45 [Improve] add Local Development and Debugging (#254)
88aeda45 is described below
commit 88aeda454b1a95dc48d5b2b2432cb53498eaebde
Author: VampireAchao <[email protected]>
AuthorDate: Sat Sep 23 18:22:32 2023 +0800
[Improve] add Local Development and Debugging (#254)
* [Improve] add Local Development and Debugging
* [Fix] fix image path
* [Fix] add images
---
docs/user-guide/3-localDevelopmentAndDebugging.md | 88 +++++++++++++++++++++
.../user-guide/3-localDevelopmentAndDebugging.md | 88 +++++++++++++++++++++
static/doc/image/streampark_build_success.png | Bin 0 -> 61813 bytes
static/doc/image/streampark_debugging.png | Bin 0 -> 762321 bytes
static/doc/image/streampark_frontend_running.png | Bin 0 -> 45565 bytes
.../image/streampark_modify_run_configuration.jpg | Bin 0 -> 243907 bytes
static/doc/image/streampark_project_build.png | Bin 0 -> 148980 bytes
static/doc/image/streampark_run_config.jpeg | Bin 0 -> 427488 bytes
static/doc/image/streampark_select_team.jpg | Bin 0 -> 69971 bytes
9 files changed, 176 insertions(+)
diff --git a/docs/user-guide/3-localDevelopmentAndDebugging.md
b/docs/user-guide/3-localDevelopmentAndDebugging.md
new file mode 100755
index 00000000..7a230148
--- /dev/null
+++ b/docs/user-guide/3-localDevelopmentAndDebugging.md
@@ -0,0 +1,88 @@
+---
+id: 'local development and debugging'
+title: 'Local Development and Debugging'
+sidebar_position: 3
+---
+
+### Environment Requirements
+
+- Maven 3.6+
+- nodejs (version >= 16.14)
+- npm 7.11.2 ( https://nodejs.org/en/ )
+- pnpm (npm install -g pnpm)
+- JDK 1.8+
+
+### Clone the Source Code
+
+```bash
+git clone https://github.com/apache/incubator-streampark.git
+```
+
+### Build the Project
+
+```bash
+cd incubator-streampark/
+./build.sh
+```
+
+
+
+### Open the Project
+
+Here, we are using `idea` to open the project.
+
+```bash
+open -a /Applications/IntelliJ\ IDEA\ CE.app/ ./
+```
+
+### Extract the Package
+
+```bash
+cd ./dist
+tar -zxvf apache-streampark-2.2.0-SNAPSHOT-incubating-bin.tar.gz
+```
+
+### Copy the Path
+
+Copy the path of the extracted directory, for example:
`/Users/user/IdeaProjects/incubator-streampark/dist/apache-streampark_2.12-2.2.0-SNAPSHOT-incubating-bin`
+
+### Start the Backend Service
+
+Navigate to
`streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/StreamParkConsoleBootstrap.java`
+
+Modify the launch configuration
+
+
+
+Check `Add VM options`, and input the parameter `-Dapp.home=$path`, where
`$path` is the path we just copied.
+
+```bash
+-Dapp.home=/Users/user/IdeaProjects/incubator-streampark/dist/apache-streampark_2.12-2.2.0-SNAPSHOT-incubating-bin
+```
+
+
+
+Then, start the backend service.
+
+### Start the Frontend Service
+
+```bash
+cd ../streampark-console/streampark-console-webapp
+pnpm serve
+```
+
+
+
+Visit `http://localhost:10001/`, enter the username `admin` and the password
`streampark`, then choose a `team` to proceed.
+
+
+
+### Demonstrate Debugging Code
+
+Select the `Project` menu, and click on build.
+
+
+
+Debugging results:
+
+
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/3-localDevelopmentAndDebugging.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/3-localDevelopmentAndDebugging.md
new file mode 100755
index 00000000..68f5bce6
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/3-localDevelopmentAndDebugging.md
@@ -0,0 +1,88 @@
+---
+id: 'local development and debugging'
+title: '本地开发调试'
+sidebar_position: 3
+---
+
+### 环境要求
+
+- Maven 3.6+
+- nodejs (version >= 16.14)
+- npm 7.11.2 ( https://nodejs.org/en/ )
+- pnpm (npm install -g pnpm)
+- JDK 1.8+
+
+### clone源码
+
+```bash
+git clone https://github.com/apache/incubator-streampark.git
+```
+
+### 构建项目
+
+```bash
+cd incubator-streampark/
+./build.sh
+```
+
+
+
+### 打开项目
+
+此处使用`idea`打开项目
+
+```bash
+open -a /Applications/IntelliJ\ IDEA\ CE.app/ ./
+```
+
+### 解压缩包
+
+```bash
+cd ./dist
+tar -zxvf apache-streampark-2.2.0-SNAPSHOT-incubating-bin.tar.gz
+```
+
+### 复制路径
+
+复制解压后的目录路径，例：`/Users/user/IdeaProjects/incubator-streampark/dist/apache-streampark_2.12-2.2.0-SNAPSHOT-incubating-bin`
+
+### 启动后台服务
+
+找到`streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/StreamParkConsoleBootstrap.java`
+
+修改启动配置
+
+
+
+勾选`Add VM options`，填写参数`-Dapp.home=$path`，`$path`是我们刚刚复制的路径
+
+```bash
+-Dapp.home=/Users/user/IdeaProjects/incubator-streampark/dist/apache-streampark_2.12-2.2.0-SNAPSHOT-incubating-bin
+```
+
+
+
+然后启动后台服务即可
+
+### 启动前端服务
+
+```bash
+cd ../streampark-console/streampark-console-webapp
+pnpm serve
+```
+
+
+
+访问 `http://localhost:10001/` ，输入用户名`admin`密码`streampark`，选择一个`team`进入
+
+
+
+### 演示调试代码
+
+选择`Project`菜单，点击build
+
+
+
+调试效果
+
+
\ No newline at end of file
diff --git a/static/doc/image/streampark_build_success.png
b/static/doc/image/streampark_build_success.png
new file mode 100644
index 00000000..4b927598
Binary files /dev/null and b/static/doc/image/streampark_build_success.png
differ
diff --git a/static/doc/image/streampark_debugging.png
b/static/doc/image/streampark_debugging.png
new file mode 100644
index 00000000..e95ed22c
Binary files /dev/null and b/static/doc/image/streampark_debugging.png differ
diff --git a/static/doc/image/streampark_frontend_running.png
b/static/doc/image/streampark_frontend_running.png
new file mode 100644
index 00000000..d39b7954
Binary files /dev/null and b/static/doc/image/streampark_frontend_running.png
differ
diff --git a/static/doc/image/streampark_modify_run_configuration.jpg
b/static/doc/image/streampark_modify_run_configuration.jpg
new file mode 100644
index 00000000..098c15eb
Binary files /dev/null and
b/static/doc/image/streampark_modify_run_configuration.jpg differ
diff --git a/static/doc/image/streampark_project_build.png
b/static/doc/image/streampark_project_build.png
new file mode 100644
index 00000000..074ed8d1
Binary files /dev/null and b/static/doc/image/streampark_project_build.png
differ
diff --git a/static/doc/image/streampark_run_config.jpeg
b/static/doc/image/streampark_run_config.jpeg
new file mode 100644
index 00000000..0a400062
Binary files /dev/null and b/static/doc/image/streampark_run_config.jpeg differ
diff --git a/static/doc/image/streampark_select_team.jpg
b/static/doc/image/streampark_select_team.jpg
new file mode 100644
index 00000000..17c0ceda
Binary files /dev/null and b/static/doc/image/streampark_select_team.jpg differ
