Quickstart

Learn how to quickly launch Kafkorama locally using Docker and explore its key features in minutes.

Welcome! Kafkorama provides a ready-to-use Docker Compose setup including:

• Kafkorama Gateway
• Kafkorama Portal
• A local Apache Kafka® broker for testing
• Several real-time demo feeds for the demo apps

To deploy Kafkorama using this setup, follow the steps below.

git clone https://github.com/kafkorama/kafkorama-deployment.git
cd kafkorama-deployment
./run.sh

From the grid button near the login button, select Administrator to see how the connection to the local Kafka cluster is configured and how a Kafka topic is exposed to Kafkorama.

Then, from the grid button again, choose API Manager to explore the demo streaming APIs. Create your own streaming API and test it by creating a new app, adopt it, define access keys to secure it, and test it using the built-in console. To create an app, from the grid button again, choose Developer Portal. Once tested, publish your streaming API to the API Hub to make it publicly discoverable.

A user of an app can adopt one or more streaming APIs for that app from the API Hub or from its own list of APIs, define access tokens for the adopted API endpoints, and then test it in the built-in console. Then go to the Clients tab and follow one of the available tutorials to build your first real-time app in your preferred programming language.

Enjoy building with Kafkorama!