docs/development/1.development.md

---
id: 'development'
title: 'Development Guide'
sidebar_position: 3
language: 'en'
---

### Environment Requirements

import { DevelopmentEnvs } from '../components/TableData.jsx';

<DevelopmentEnvs></DevelopmentEnvs>

### Clone the Source Code

```bash
git clone https://github.com/apache/streampark.git
```

### Build the Project

```bash
cd 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-incubating-bin.tar.gz
```

### Copy the Path

Copy the path of the extracted directory, for example: `${workspace}/streampark/dist/apache-streampark-2.2.0-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

![Streampark Modify Run Configuration](/doc/image/streampark_modify_run_configuration.jpg)

Check `Add VM options` and `Add dependencies with "provided" scope to classpath`, and input the parameter `-Dapp.home=$path`, where `$path` is the path we just copied.

```bash
-Dapp.home=${workspace}/streampark/dist/apache-streampark-2.2.0-incubating-bin
```

![Streampark Run Config](/doc/image/streampark_run_config.jpeg)

Then, start the backend service.

### Start the Frontend Service

```bash
cd ../streampark-console/streampark-console-webapp
pnpm serve
```

![Streampark Frontend Running](/doc/image/streampark_frontend_running.png)

Visit `http://localhost:10001/`, enter the username `admin` and the password `streampark`, then choose a `team` to proceed.

![Streampark Select Team](/doc/image/streampark_select_team.jpg)

### Demonstrate Debugging Code

1.Start the project in debug mode in Idea

2.Add breakpoints in the link/app/list of the Application Controller

![Streampark Project Build](/doc/image/streampark_debug_build.png)

3.Entering your account password to log in to streampark and selecting team will trigger a breakpoint

![Streampark Project Build](/doc/image/streampark_debugging.png)