0ct0pu5/kafka-ui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kafka-ui/documentation/project/contributing/prerequisites.md
Jibin Philipose 9f32abcd09
New documentation for building and running without docker (#2574) 
* New documentation for building and running without docker and some doc fixes and additions.

* Improvements in docs

* spell fix

* improvements in docs

* minor modification

* improvements
2022-09-15 04:38:05 +04:00

979 B
Raw Blame History

Prerequisites

This page explains how to get the software you need to use a Linux or macOS machine for local development.

Before you begin contributing you must have:

  • A GitHub account
  • Java 13 or newer
  • Git
  • Docker

Installing prerequisites on macOS

  1. Install brew.
  2. Install brew cask:
brew cask
  1. Install JDK 13 via Homebrew cask:
brew tap adoptopenjdk/openjdk
brew install adoptopenjdk13
  1. Verify Installation
java -version

Note : In case JAVA13 is not set as your default Java then you can consider to include JAVA13 in your PATH after installation

export PATH="/Library/Java/JavaVirtualMachines/adoptopenjdk-13.jdk/Contents/Home/bin:$PATH

Tips

Consider allocating not less than 4GB of memory for your docker. Otherwise, some apps within a stack (e.g. kafka-ui.yaml) might crash.

Where to go next

In the next section, you'll learn how to Build and Run kafka-ui.