create-xkite v1.0.0

create-xkite

A Graphical User Interface (GUI) for Kafka Integrated Testing Environment (KITE)

The xkite GUI supports comprehensive prototyping, testing, and monitoring toolset built for Apache Kafka.

Built upon xkite-core library, xkite GUI provides functionality to configuring a YAML file, managing docker containers (configure, run, pause, and shutdown), interfacing with a remote xkite servers, and exporting their configuration to deploy their docker ecosystem to the cloud.

Use xkite to bootstrap your next project, or install our library into an existing project. Built by (and for) developers.

Note: xkite is also available with the full graphical user interface using our xkite GUI.

Dependencies

• Latest stable versions of Node.js and NPM installed
• Latest stable version of docker-compose installed.
• Docker daemon is running for reference: Docker Getting Started
• Clone repository: git clone https://github.com/oslabs-beta/xkite.git
• Install dependencies: Run npm install inside the project folder

Quick Start

To install/run the xkite GUI please use the following command:

  $ npx create-xkite <directory-name>

After the installation is complete, users can start the server by following the steps below:

1. $ cd <directory-name>

2. $ npm run dev

A browser window will open on http://localhost:3000 where users will see the live preview of the application.

Note: If the port 3000 is not available the server will start on the closest available port after 3000.

Note

• Users must have Docker daemon active and running to initiate an xkite local deployment.

See the xkite documentation for further details