StreamScaffold

KO | EN

gitlite — search

#react #ai #llm #golang #android #rust #deep-learning #linux #docker #nodejs #awesome #kubernetes #awesome-list #mcp

(★ 10)

a lightweight, browser-based tool designed to generate development-ready `docker-compose.yml` configurations for the Confluent Community Kafka Platform.

StreamScaffold Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# StreamScaffold - Kafka Stack Generator
**StreamScaffold** is a lightweight, browser-based tool designed to generate development-ready `docker-compose.yml` configurations for the Confluent Community Kafka Platform. It simplifies the complexity of setting up a local development environment for event streaming applications.

![StreamScaffold Preview](https://raw.githubusercontent.com/mrunderline/StreamScaffold/master/Preview.png)

## 🌐 Live Demo
Try StreamScaffold directly in your browser: **[GitHub Pages](https://mrunderline.github.io/StreamScaffold)**

## ⚠️ Important Notice
**This is a weekend project** and is **NOT ready for production environments**.

- Use it for **local development and learning purposes only**.
- Generated configurations may require manual adjustments for production use.
- Always review and test the generated `docker-compose.yml` before deploying.
- Security, performance tuning, and production best practices are not included.

## ✨ Features
-  **Consensus Modes**: Support for both modern **KRaft** (Zookeeper-less) and legacy **Zookeeper** modes.
-  **Modular Components**: Toggle Confluent components on demand:
	- Schema Registry
	- Kafka Connect
	- ksqlDB Server
	- REST Proxy
-  **Dev Tools included**:
	-  **Kafka UI** (Provectus) for cluster management.
	-  **kcat** container for CLI debugging.
	-  **Prometheus & Kafka Exporter** for monitoring.
-  **Instant Preview**: Real-time YAML generation and documentation.
-  **Zero Dependencies**: Runs entirely in the browser (HTML/JS/CSS).
-  **Mobile Friendly**: Responsive design for checking configurations on the go.

## 🚀 Usage
Since StreamScaffold is a client-side application, you don't need to install Node.js, Python, or any backend server.

**Quick Start:** Use the [live demo](https://mrunderline.github.io/StreamScaffold/index.html) on GitHub Pages.

**Local Setup:**
 
1. **Clone the repository:**
```bash
git clone https://github.com/mrunderline/StreamScaffold.git
cd StreamScaffold
```

2. **Run the app:**  Simply open `index.html` in your web browser.

3.  **Generate your Stack:**
	- Select your preferred Confluent version.
	- Choose between KRaft or Zookeeper mode.
	- Toggle the components you need.
	- Click **Download** to get your `docker-compose.yml` and `README.md`.

4.  **Start Kafka:** Place the downloaded files in a folder and run:
```bash
docker-compose up -d
```

## 🛠️ Tech Stack
-  **HTML5 & Vanilla JavaScript**: Core logic and rendering.
-  **Tailwind CSS**: Styling (loaded via CDN).
-  **Marked.js**: Markdown rendering for the preview tab.
-  **Docker**: The target platform for the generated configurations.

## 🤝 Contribution
Contributions are welcome! If you want to add support for more components (e.g., Redpanda, Enterprise features) or improve the UI:
1. Fork the project.
2. Create a feature branch (`git checkout -b feature/AmazingFeature`).
3. Commit your changes.
4. Push to the branch.
5. Open a Pull Request.

## 📝 License
Distributed under the MIT License.

StreamScaffold

StreamScaffold Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

StreamScaffold

StreamScaffold Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README