| <!-- |
| ~ 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. |
| ~ |
| --> |
| |
| Apache StreamPark |
| ========== |
| |
| <img src="https://streampark.apache.org/image/logo_name.png" alt="StreamPark logo" height="90px" align="right" /> |
| |
| **StreamPark**: a streaming application development framework and cloud-native real-time computing platform. |
| |
| [](https://github.com/apache/streampark/stargazers) |
| [](https://github.com/apache/streampark/releases) |
| [](https://x.com/ASFStreamPark) |
| |
| ## 📊 Overview |
| |
| **StreamPark** is an open-source framework for building and managing real-time streaming applications, designed to simplify the end-to-end lifecycle of stream processing. It provides a unified development framework for Apache Flink and Apache Spark, along with a powerful cloud-native platform for application management. |
| |
| StreamPark enables users to develop, debug, deploy, and operate large-scale streaming applications efficiently and consistently. |
| Originally named StreamX, the project was renamed StreamPark in August 2022 and became an Apache Top-Level Project (TLP) in January 2025. |
| |
| * **Streaming Application Development Framework** |
| * Simplifies Flink and Spark streaming development with prebuilt APIs, connectors, and templates. |
| * **Cloud-Native Real-Time Computing Platform** |
| * Offers a one-stop real-time computing platform for development, deployment, monitoring, and operations. |
| * **Unified Batch & Streaming Processing** |
| * Supports Apache Flink and Apache Spark, enabling both stream processing and batch processing. |
| * **Multi-Engine & Multi-Version Support** |
| * Run and manage multi-version Flink/Spark applications. |
| * **Multi-Environment Compatibility** |
| * Works on Standalone, YARN (Hadoop 2.x/3.x), and Kubernetes. |
| * **Rich Ecosystems** |
| * Compatible with big-data ecosystem tools (e.g., Apache Flink/Spark/Paimon/Doris) and ML/AI ecosystems. |
| * **Easy to use** |
| * Single-service deployment; go from zero to running jobs in minutes. |
| |
| <img src="https://streampark.apache.org/image/dashboard-preview.png"/> |
| |
| ## 🚀 QuickStart |
| |
| #### 🐳 Play StreamPark in Docker |
| |
| ```shell |
| docker run -d -p 10000:10000 apache/streampark:latest |
| ``` |
| |
| --- |
| |
| #### 🖥️ Local Quick Installation Experience |
| |
| ```shell |
| curl -L https://streampark.apache.org/quickstart.sh | sh |
| ``` |
| https://github.com/user-attachments/assets/dd7d5a89-bc28-4ccc-9ad5-258925fc4f34 |
| |
| ## 🔨 How to Build |
| |
| ```shell |
| ./build.sh |
| ``` |
| |
| 🗄 how to [Development](https://streampark.apache.org/docs/development/development) |
| |
| ## ⬇️ Downloads |
| |
| Please head to the [releases page](https://streampark.apache.org/download) to download a release of Apache StreamPark. |
| |
| ## 📚 Docs |
| |
| [Official Documentation](https://streampark.apache.org/docs/get-started) |
| |
| ## 💋 Our users |
| |
| Various companies and organizations use Apache StreamPark for research, production and commercial products. Are you using this project? [Welcome to add your company](https://github.com/apache/streampark/issues/163)! |
| |
|  |
| |
| |
| ## 🤝 Contribution |
| |
| [](https://github.com/apache/streampark/pulls) |
| |
| ### 🙋 Submit Pull Request and Issues |
| |
| You can submit any ideas as [pull requests](https://github.com/apache/streampark/pulls) or as [issues](https://github.com/apache/streampark/issues/new/choose). |
| |
| > If you're new to posting issues, we ask that you read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) (**This guide does not provide actual support services for this project!**), [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) prior to posting. Well written bug reports help us help you! |
| |
| ### 🍻 How to Contribute |
| |
| We welcome your suggestions, comments (including criticisms), comments and contributions. See [How to Contribute](https://streampark.apache.org/community/submit_guide/submit_code) and [Code Submission Guide](https://streampark.apache.org/community/submit_guide/code_style_and_quality_guide) |
| |
| Thank you to all the people who already contributed to Apache StreamPark! |
| |
| ## 💬 Contact Us |
| |
| Contact us through the following mailing list. |
| |
| | Name | Mailing list | |
| |:--------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| | [dev@streampark.apache.org](mailto:dev@streampark.apache.org) | [Subscribe](mailto:dev-subscribe@streampark.apache.org)、[Unsubscribe](mailto:dev-unsubscribe@streampark.apache.org) 、[Archives](http://mail-archives.apache.org/mod_mbox/streampark-dev/) | |
| |
| |
| ## 💿 Social Media |
| |
| - [X (Twitter)](https://twitter.com/ASFStreamPark) |
| - [Zhihu](https://www.zhihu.com/people/streampark) (in Chinese) |
| - [bilibili](https://space.bilibili.com/455330087) (in Chinese) |
| - WeChat Official Account (in Chinese, scan the QR code to follow) |
| |
| <img src="https://streampark.apache.org/image/wx_qr.png" alt="Join the Group" height="300px"><br> |
| |
| |
| ## 📜 License |
| |
| Licensed under the [Apache License, Version 2.0](LICENSE) |
