zookeeper

(β˜… 12,792)

Apache ZooKeeper

  • .asf.yaml
  • .gitattributes
  • .gitignore
  • .typos.toml
  • checkstyle-simple.xml
  • checkstyle-strict.xml
  • checkstyleSuppressions.xml
  • excludeFindBugsFilter.xml
  • Jenkinsfile
  • Jenkinsfile-owasp
  • Jenkinsfile-PreCommit
  • Jenkinsfile-s390x
  • LICENSE.txt
  • NOTICE.txt
  • owaspSuppressions.xml
  • pom.xml
  • README.md
  • README_packaging.md
  • zk-merge-pr.py

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/apache/zookeeper

Downloads the entire project code from GitHub to your computer.

cd zookeeper

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f dev/docker/Dockerfile -t zookeeper .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 zookeeper

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
cd zookeeper-client/zookeeper-client-c

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
mvn clean install

Installs dependencies and builds the project using Maven.

mvn javadoc:aggregate

Installs dependencies and builds the project using Maven.

βœ… A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd zookeeper-website

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

6. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly β€” no need to clone the source.

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

7. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd zookeeper-contrib/zookeeper-contrib-huebrowser/zkui

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation