Building

To make the most of JR, recompile it from the source.

Clone the JR repository:

git clone https://github.com/jrnd-io/jr

This is needed if you want to serialize with AVRO your own templates, though it’s NOT needed if you are using AVRO only with the predefined templates)

Building JR on Linux/Mac

JR requires Go 1.22

you can use the make_install.sh to install JR. This script does everything needed in one simple command.

./make_install.sh

These are the steps in the make_install.sh script if you want to use them separately:

# generates the code and compile everything
make all
# copy the templates and data directory in the .jr in your $HOME folder
make copy_templates  
# copy the jr bin in /usr/local/bin
sudo make install

If you want to run the Unit tests, you have a make target for that too:

make test

Building JR on Windows

• Install MSYS2 https://www.msys2.org/

  winget install --id=MSYS2.MSYS2  -e
  

• Open the MSYS2 terminal and update the package database and core system packages:

  pacman -Syu
  

• After updating, close the terminal and open it again to continue the update process:

  pacman -Su
  

• Install Required Packages in MSYS2

  pacman -S base-devel mingw-w64-x86_64-toolchain mingw-w64-x86_64-cmake 
  mingw-w64-x86_64-pkg-config
  

• Clone the librdkafka repository:

  git clone https://github.com/edenhill/librdkafka.git
  cd librdkafka
  

• Create a build directory and navigate into it:

  mkdir build 
  cd build
  

• Build librdkafka, this will install DLLs under C:/Program Files (x86)/RdKafka/bin/

  ${MINGW_PREFIX}/bin/cmake -G "MSYS Makefiles" ..
  make install
  

• Clone the JR repository

  git clone https://github.com/jrnd-io/jr
  cd jr
  

• Install and configure Go

  pacman -S mingw-w64-x86_64-go
  export GOROOT=${MINGW_PREFIX}/lib/go
  make all
  make copy_templates
  make copy_config
  make install